[xml doc] RemovedPHP4StyleConstructors#1292
Merged
jrfnl merged 4 commits intoPHPCompatibility:developfrom Mar 27, 2023
afilina:php4construct
Merged
[xml doc] RemovedPHP4StyleConstructors#1292jrfnl merged 4 commits intoPHPCompatibility:developfrom afilina:php4construct
jrfnl merged 4 commits intoPHPCompatibility:developfrom
afilina:php4construct
Conversation
Member
|
Rebased the PR and updated the document (with permission from @afilina). Will merge this one once the build passes. |
… tweaks
* 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.
* Use `Cross-version compatible` and `PHP </> #.#` 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.
Make it clearer that a PHP 4 style constructor method accompanied by a `__construct()` method will not be flagged.
* Add `<em>` tags to the code samples to allow for highlighting the specific issue the sniff is looking for.
* Remove code samples related to things PHPCompat doesn't check/sniff for.
While the code samples about calling direct/indirect parent constructors is good and valid information, the sniff does not look for that and PHPCompatibility is incapable of flagging this as it would involve, in most cases, cross-file analysis.
The documentation is only supposed to inform the users about what the PHPCompatibility sniff flags.
* Move the `link` element to be an attribute of the description element to comply with the XML schema.
jrfnl
approved these changes
Mar 27, 2023
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.
Related to #1285