[wp-trac] [WordPress Trac] #34861: Improve documentation for wp_count_terms()

[WordPress Trac]

#34861: Improve documentation for wp_count_terms()
----------------------------------------+------------------------------
 Reporter:  swissspidy                  |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Taxonomy                    |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs
----------------------------------------+------------------------------
Description changed by swissspidy:

Old description:

> `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 [https://make.wordpress.org/core/handbook/best-practices/inline-
> documentation-standards/php/#docblock-formatting PHP documentation
> standards] for more details.

New description:

 `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 [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#1-functions-class-methods PHP documentation
 standards] for more details.

--

--
Ticket URL: <https://core.trac.wordpress.org/ticket/34861#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform