docs: document a workaround for pdd and multiline comments

Relate to #1610

[skip ci]

Author: php-coder

docs/decisions-log.md

@@ -2,6 +2,7 @@
 
 | Date/Type | Description |
 | --------- | ----------- |
+| 16.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in one of the releases **pdd** has changed it's behavior for parsing of the multiline comments: previously, in order to be included in a title, the next line should have started from a space. The current behavior is that pdd reads all the next lines until a comment ends or the next puzzle appears. I had to modify the existing comments in order to make their titles look as expected. I also submitted an issue to the upstream in order to improve documentation regarding these rules. Commits: [c2adb2aa](https://github.com/php-coder/mystamps/commit/c2adb2aad0ea58a1aee85cbe4aa5838dfb70f510) Issue: [cqfn/pdd#224](https://github.com/cqfn/pdd/issues/224) |
 | 16.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): **pdd** incorrectly parses single line HTML comments and doesn't remove a trailing `-->` characters. They are being included in a title and it looks ugly. I have already reported that issue a few years back, but the issue got closed with a suggestion to modify the comments and make them multiline. I followed that advice and modified the comments. Commits: [20b47a73](https://github.com/php-coder/mystamps/commit/20b47a733533bfdd93164a1fd77e6f23e03a1ea2) Bug: [cqfn/pdd#111](https://github.com/cqfn/pdd/issues/111) |
 | 12.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in order to work with `pdd.xml` that is generated by **pdd**, I needed a simple cli tool. I'd like to use `jq` for that purpose, but pdd doesn't support JSON as an output format. I created a feature request for that and I also wrote `pdd-xml-to-json.sh` to use as a workaround. Despite that later I have decided to use TSV as a primary format, I still use JSON as an intermediary format. Commits: [597aabf5](https://github.com/php-coder/mystamps/commit/597aabf5c2ca7f5406d81fed067e5e49dc91af1f) Issue: [cqfn/pdd#223](https://github.com/cqfn/pdd/issues/223) |
 | 30.05.2023 Decision | [php-coder/mystamps#1595](https://github.com/php-coder/mystamps/issues/1595): The rate of issues that I faced with pdd/**0pdd** is too high. Time to time, it tries to create the duplicated issues or close issues while the comments are still in place. Also the issues that have been reported to upstream didn't have reaction from the maintainers for a long time. I decided that its cons overweight the pros and I dicontinued a usage of 0pdd. At the same time, the approach is still seems useful so I'm going to create my own solution that will be based on pdd and Github Actions (see [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610)). While pdd also has bugs and it isn't actively maintained, neverthereless I can fix the code by myself or I will be able to add workarounds if needed. |