[wp-trac] [WordPress Trac] #46891: Docs: Add missing description for global wpdb param
WordPress Trac
noreply at wordpress.org
Fri Apr 12 13:30:39 UTC 2019
#46891: Docs: Add missing description for global wpdb param
-------------------------------------+-----------------------------
Reporter: immeet94 | Owner: (none)
Type: defect (bug) | Status: new
Priority: normal | Milestone: Future Release
Component: General | Version:
Severity: normal | Resolution:
Keywords: has-patch needs-refresh | Focuses: docs
-------------------------------------+-----------------------------
Changes (by afercia):
* keywords: has-patch => has-patch needs-refresh
* priority: low => normal
* type: enhancement => defect (bug)
* severity: minor => normal
Comment:
Thanks @immeet94 ! Searching through the codebase for `@global wpdb`, it
seems there are more occurrences where `wpdb` misses a description. Would
be great to fix also the other occurrences.
Also, when there are multiple globals (same for params), the type,
varname, and descriptions should be aligned with spaces. An example would
be:
{{{
* @global wpdb $wpdb The WordPress database class.
* @global string $table_prefix The database table prefix.
}}}
Reference to the documentation coding standards:
https://make.wordpress.org/core/handbook/best-practices/inline-
documentation-standards/php/#docblock-formatting
--
Ticket URL: <https://core.trac.wordpress.org/ticket/46891#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list