Documentation: improve sniff class descriptions #939
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
* Improve short descriptions. * Where relevant, add long descriptions with more details about the PHP change and how the sniff handles it. * Add _PHP version x.x_ annotations. * Add `@link` tags to the relevant PHP documentation which led to the sniff. And make sure these are in a consistent order as per above.
jrfnl
force-pushed
the
feature/docs/improve-class-descriptions
branch
from
92ad3e0
to
bebbabd
Compare
wimg
approved these changes
Dec 21, 2019
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.
@linktags to the relevant PHP documentation which led to the sniff.@sincetags with limited class changelog.And make sure these are in a consistent order as per above.
These descriptions and such can no doubt still be further improved, but this is a large step in the right direction.
Related to #734