Opened 7 years ago
Closed 7 years ago
#46891 closed defect (bug) (duplicate)
Docs: Add missing description for global wpdb param
| Reported by: | immeet94 | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | General | Version: | |
| Severity: | normal | Keywords: | has-patch needs-refresh |
| Cc: | Focuses: | docs, coding-standards |
Description
i found that there is missing $wpdb declaration in files.
Attachments (2)
Change History (7)
#1
@
7 years ago
- Focuses coding-standards removed
- Milestone Awaiting Review → Future Release
- Priority normal → low
- Severity normal → minor
- Summary Needs documentation improvement. → Docs: Add missing description for global wpdb param
- Type defect (bug) → enhancement
- Version trunk
#2
@
7 years ago
- Keywords needs-refresh added
- Priority low → normal
- Severity minor → normal
- Type enhancement → defect (bug)
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
Note:
See TracTickets
for help on using tickets.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
Please see this file for patch