Opened 9 years ago
Closed 9 years ago
#34861 closed defect (bug) (fixed)
Improve documentation for wp_count_terms()
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Milestone: | 4.5 | Priority: | normal |
| Severity: | normal | Version: | 2.3 |
| Component: | Taxonomy | Keywords: | has-patch good-first-bug |
| Focuses: | docs | Cc: |
Description (last modified by )
wp_count_terms() takes an optional $args param that is passed to get_terms. Although that function is referenced in the docblock, it should probably use a proper @see reference. Duplicating the whole hash notation for $args probably doesn't make sense, though there's a @todo comment about it.
See the PHP documentation standards for more details.
Attachments (2)
Change History (7)
#3
@
9 years ago
- Keywords good-first-bug added
- Owner set to bordoni
- Status changed from new to assigned
- Version changed from trunk to 2.3
Hi @bordoni, thanks for your patch!
Please note that code refactoring (even just adding spaces) shouldn't be done for the sake of refactoring. See https://make.wordpress.org/core/2011/03/23/code-refactoring/ for details. We're concentrating on the docblock here.
Besides that, Version is used to indicate the WordPress version this bug was first introduced and the good-first-bug keyword should remain. Instead, I'll set you as an owner here, marking this good-first-bug as claimed.
#4
@
9 years ago
- Milestone changed from Awaiting Review to 4.5
34861.diff is an updated patch without the coding standards changes; also removing the @todo from the DocBlock.
PHP Code Std + Docblock changes