Skip to content

[xml doc] ReservedFunctionNames#1293

Merged
jrfnl merged 2 commits intoPHPCompatibility:developfrom
afilina:reserved-func-name
Mar 27, 2023
Merged

[xml doc] ReservedFunctionNames#1293
jrfnl merged 2 commits intoPHPCompatibility:developfrom
afilina:reserved-func-name

Conversation

@afilina
Copy link
Contributor

@afilina afilina commented Aug 16, 2021

Related to #1285

@jrfnl jrfnl added this to the 10.0.0 milestone Mar 27, 2023
@jrfnl
Copy link
Member

jrfnl commented Mar 27, 2023

Rebased the PR and updated the document (with permission from @afilina). Will merge this one once the build passes.

* Add proper XML header.
    Note: this is something which only recently became an option as there previously was no schema available.
* Style: have `CDATA` tags on their own lines.
    This makes the XML code style consistent with currently existing XML docs.
* Expand the issue description.
* Add descriptions for the code samples.
* Fix code sample for what the sniff is looking for.
    Make it clearer that a double underscore prefix is allowed for magic methods.
* Add `<em>` tags to the code samples to allow for highlighting the specific issue the sniff is looking for.
* Move the `link` element to be an attribute of the description element to comply with the XML schema.
@jrfnl jrfnl merged commit 29b2f8a into PHPCompatibility:develop Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants