[xml doc] ReservedFunctionNames #1293
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrfnl
force-pushed
the
reserved-func-name
branch
from
85a8c43
to
51c2a77
Compare
|
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
force-pushed
the
reserved-func-name
branch
from
51c2a77
to
98d3d67
Compare
jrfnl
approved these changes
Mar 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #1285