Docs: remove redundant @package tags
#320
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
`@package` tags are an arcane manner to group related files as belonging to one project. For projects using namespaces, the current recommendation is to only have `@package` tags when they have supplemental information to the namespace. As that isn't the case in YoastCS (with the exception of the non-namespaced test bootstrap file), I'm proposing to remove the `@package` tags from the YoastCS class docblocks. Along the same lines, the `@author` tag is also an outdated practice as `git blame` will work just fine, so I'm removing those too. Includes cleaning up (normalizing) the tag description alignments in the class docblocks. :point_right: reviewing with whitespace changes ignored should make it easier to see that the only real change is the removal of the package/author tags. Refs: * https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/package.html#package * https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#59-package
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.
@packagetags are an arcane manner to group related files as belonging to one project.For projects using namespaces, the current recommendation is to only have
@packagetags when they have supplemental information to the namespace.As that isn't the case in YoastCS (with the exception of the non-namespaced test bootstrap file), I'm proposing to remove the
@packagetags from the YoastCS class docblocks.Along the same lines, the
@authortag is also an outdated practice asgit blamewill work just fine, so I'm removing those too.Includes cleaning up (normalizing) the tag description alignments in the class docblocks.
👉 reviewing with whitespace changes ignored should make it easier to see that the only real change is the removal of the package/author tags.
Refs: