CS: remove redundant file docblocks #136
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
In YoastCS, namespaced files do not require a docblock and it is recommended not to have one. This commit fixes this for all namespaced files in the Duplicate Post plugin. Includes: * Moving the functionality description from the file docblock to the class docblock if it was more descriptive than the description given in the class docblock. * Moving any other relevant tags, like `@since` from the file docblock to the class docblock. * Removing redundant `@package` tags in class docblock.
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.
Context
Summary
This PR can be summarized in the following changelog entry:
Relevant technical choices:
In YoastCS, namespaced files do not require a docblock and it is recommended not to have one.
This commit fixes this for all namespaced files in the Duplicate Post plugin.
Includes:
@sincefrom the file docblock to the class docblock.@packagetags in class docblock.Test instructions
This PR can be tested by following these steps:
This is a code-only change and should have no effect on the functionality. If the build passes (linting, test runs), we're good.