[xml doc] ArgumentFunctionsReportCurrentValue#1294
Merged
jrfnl merged 3 commits intoPHPCompatibility:developfrom Mar 28, 2023
afilina:arg-func-current-value
Merged
[xml doc] ArgumentFunctionsReportCurrentValue#1294jrfnl merged 3 commits intoPHPCompatibility:developfrom afilina:arg-func-current-value
jrfnl merged 3 commits intoPHPCompatibility:developfrom
afilina:arg-func-current-value
Conversation
Member
|
Rebased the PR and updated the document (with permission from @afilina). Will merge this one once the build passes. |
jrfnl
approved these changes
Mar 28, 2023
* 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 and add a second description section about the "manual inspection" warning.
* Use `Cross-version compatible` and `Cross-version INcompatible:` style prefixes in the code samples.
This improves consistency with the other XML docs and makes the code samples more descriptive in the context of PHPCompatibility.
* Fix code sample for what the sniff is looking for and add a lot more code samples.
Make it clearer which type of code is affected by this change in PHP and when the issue doesn't apply.
* Improve the code sample descriptions.
* 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.
This file contains hidden or 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
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.
I'm not sure whether the
phpcs:ignorecomment should be part of the base example or not. I also didn't know how to split a non-splittable comment to fit within the narrow CLI block, so I improvised:Related to #1285