Docs: various @var/@param/@return tag improvements #770
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
... and use consistent spacing (blank line between param and return tags).
Definitely not claiming completeness. This is just another iteration step in improving the documented types.
While WP tends to omit `@return void` statements, this is not WP and documenting the function return type is a good thing™.
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.
Docs: improve test @return tags
... and use consistent spacing (blank line between param and return tags).
Docs: various @var/@param/@return tag improvements
Definitely not claiming completeness. This is just another iteration step in improving the documented types.
Docs: add missing @return tags
While WP tends to omit
@return voidstatements, this is not WP and documenting the function return type is a good thing™.