Skip to content
This repository was archived by the owner on Sep 28, 2023. It is now read-only.

Docs: various minor tweaks#54

Merged
jrfnl merged 2 commits intomasterfrom
JRF/Docs/various-tweaks
Jan 14, 2020
Merged

Docs: various minor tweaks#54
jrfnl merged 2 commits intomasterfrom
JRF/Docs/various-tweaks

Conversation

@jrfnl
Copy link
Copy Markdown
Contributor

@jrfnl jrfnl commented Jan 14, 2020

Docs: remove redundant @access tags

Tag Usage Description
@access private Only used in limited circumstances, and only when private, such as for core-only functions or core classes implementing “private” APIs. Used directly below the @since line in block.

Source: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#phpdoc-tags

If used at all, the @access tag should only be used on global functions/variables where the visibility can't be set via a modifier.

After this commit, there are two @access private tags remaining. These are set for public methods.
For those, it should be decided whether the method visibility is correct and if not, the method visibility should be changed.
Either way, the tag should be removed after this has been examined.

Docs: return values do not have a name

jrfnl added 2 commits January 14, 2020 19:57
> Tag |	Usage |	Description
> --- | --- | ---
> @access | private | Only used in limited circumstances, and only when private, such as for core-only functions or core classes implementing “private” APIs. Used directly below the @SInCE line in block.

Source: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#phpdoc-tags

If used at all, the `@access` tag should only be used on global functions/variables where the visibility can't be set via a modifier.

After this commit, there are two `@access private` tags remaining. These are set for `public` methods.
For those, it should be decided whether the method visibility is correct and if not, the method visibility should be changed.
Either way, the tag should be removed after this has been examined.
@jrfnl jrfnl added this to the Next release milestone Jan 14, 2020
@jrfnl jrfnl merged commit d903e42 into master Jan 14, 2020
@jrfnl jrfnl deleted the JRF/Docs/various-tweaks branch January 14, 2020 20:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant