[wp-trac] [WordPress Trac] #32139: Add PHPDoc for all global $wp_query in /wp-includes/query.php
WordPress Trac
noreply at wordpress.org
Sat Sep 19 23:52:12 UTC 2015
#32139: Add PHPDoc for all global $wp_query in /wp-includes/query.php
--------------------------+-----------------------
Reporter: MikeSchinkel | Owner:
Type: enhancement | Status: reopened
Priority: normal | Milestone: 4.4
Component: Query | Version:
Severity: normal | Resolution:
Keywords: | Focuses: docs
--------------------------+-----------------------
Changes (by DrewAPicture):
* keywords: dev-feedback needs-patch =>
* status: closed => reopened
* resolution: fixed =>
* milestone: 4.3 => 4.4
Comment:
Replying to [comment:7 MikeSchinkel]:
> '''So the question for the core committers comes to this''':
>
> 1. Would you prefer well-known WordPress global variables be documented
in every function and method where they are found,
>
> 2. Would you prefer to document all well-known WordPress global
variables '''only once''', as in `/wp-includes/vars.php`, or
>
> 3. Will we find that you ''(the core committers)'' are simply
uninterested in this and that any effort on this will be a waste of time?
Sorry, @MikeSchinkel: didn't see your comment above from a few months ago.
I'm going to go with door number 3 for now. I think globals are adequately
accounted for in the docs standard currently, and any specific updates
largely for the benefit of IDEs and not much else falls pretty low on the
priority list.
Replying to [comment:13 wonderboymusic]:
> [32620] fixed this ticket inadvertently using our current docs standards
I believe our docs standards call for descriptions on `@global` tags :-)
Let's get the descriptions added then we can call this fixed.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/32139#comment:14>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list