[wp-trac] [WordPress Trac] #27200: Remove all @package and @subpackage tags from function DocBlocks
WordPress Trac
noreply at wordpress.org
Tue Feb 25 16:26:26 UTC 2014
#27200: Remove all @package and @subpackage tags from function DocBlocks
--------------------------+------------------------------
Reporter: DrewAPicture | Owner:
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: General | Version:
Severity: normal | Resolution:
Keywords: has-patch | Focuses: docs
--------------------------+------------------------------
Comment (by GaryJ):
Just as those bundled libs come with them because the libs can be used in
a wider system, so should WordPress. If WP is used in a wider system
(making up only a part of a website or online presence), then parsing the
whole system will neatly mark out what is WP, what is Magento, and what is
something else. It's playing nicely with others, and it's the right thing
to do, even if WP has no sub packages and everything is `@package
WordPress`.
There shouldn't be the ambiguity of looking at a file from WP, and having
to assume it's a WordPress file rather than a lib, because there's no
`@package` tag.
The other thing is for file identification - should a file be found and
read out of context (i.e. outside of a WP-only site, by someone who
doesn't know WP), then having a file-level DocBlock at the top (fairly
consistent for each and every file) with a `@package` tag instantly
identifies where that file has come from.
Let's not get distracted from the ticket - that function-level `@package`
and `@subpackage` tags are wrong, and should be removed regardless of
follow-ups related to the use of `@package` throughout WP.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/27200#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list