Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: various @var/@param/@return tag improvements #770

Merged
merged 3 commits into from
Aug 23, 2023

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Aug 23, 2023

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 void statements, this is not WP and documenting the function return type is a good thing™.

jrfnl added 3 commits August 23, 2023 21:27
... 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™.
@jrfnl jrfnl added this to the 2.3.4 milestone Aug 23, 2023
@jrfnl jrfnl requested a review from a team as a code owner August 23, 2023 19:31
Copy link
Contributor

@GaryJones GaryJones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GaryJones GaryJones merged commit 332b8dd into develop Aug 23, 2023
@GaryJones GaryJones deleted the feature/more-docs-fixes branch August 23, 2023 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants