Docs: improve type declarations #189
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
This commit addresses the `@return` tag for all sniff `register()` methods. Future commits may follow for other parts of the codebase. PHP native tokens will always be integers. PHP_CodeSniffer polyfilled and PHP_CodeSniffer native tokens will always be strings. While some sniffs only return one or the other, I've chosen to update these tags to be the same across all sniffs for consistency.
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.
Description
This commit addresses the
@returntag for all sniffregister()methods. Future commits may follow for other parts of the codebase.PHP native tokens will always be integers.
PHP_CodeSniffer polyfilled and PHP_CodeSniffer native tokens will always be strings.
While some sniffs only return one or the other, I've chosen to update these tags to be the same across all sniffs for consistency.
Suggested changelog entry
N/A