Introducing a semantic changelog XML notation
| From: | Giovanni Giacobbi | Date: | Wed, 11 Mar 2020 08:33:12 +0000 |
| Subject: | Introducing a semantic changelog XML notation | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969387487@lists.php.net to get a copy of this message | ||
Greetings,
I recently did my first contribution to the phpdocs, it was a missing
changelog entry for mb_convert_case(). For the first time I saw the syntax
of the XML files and I had the immediate feeling a semantic <changelog> XML
construct is missing.
Given the importance of the changelog (as full time PHP developer I consult
the "Changelog" section of the manual pages A LOT) I believe it deserves
its own XML tag instead of using <informaltable>.
I was thinking about something like (a very random idea, not thought
through yet):
<changelog>
<row>
<version>7.3.0</version>
<entry>Changed this and that.</entry>
</row>
</changelog>
Do you think this kind of change would be accepted? Has this been discussed
before?
It would be quite some work to introduce the new markup and create a
migration script for the existing documentation, so I'm looking for
preliminary feedback before venturing into this.
Thank you for your attention.
GG.