[wp-trac] [WordPress Trac] #47896: Docs: add missing argument in the wp_list_categories function docblock
WordPress Trac
noreply at wordpress.org
Mon Aug 26 16:58:02 UTC 2019
#47896: Docs: add missing argument in the wp_list_categories function docblock
--------------------------+---------------------------
Reporter: audrasjb | Owner: boonebgorges
Type: defect (bug) | Status: closed
Priority: normal | Milestone: 5.3
Component: Taxonomy | Version:
Severity: normal | Resolution: fixed
Keywords: has-patch | Focuses: docs
--------------------------+---------------------------
Comment (by SergeyBiryukov):
Replying to [comment:8 boonebgorges]:
> I'd spell out the principle as follows:
>
> 1. If a function accepts arguments that are passed through, without
modification, to another function, then those arguments should not be
documented on the wrapper function, but there should be a reference along
the lines of `See get_terms()` in the description of `$args`.
> 2. The wrapper function should fully document arguments that (a) are not
passed through at all (such as `$title_li`) or (b) are modified or play a
special role in the wrapper (such as `$exclude_tree`).
For reference, this was previously discussed in #41058, specifically
comment:8:ticket:41058.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/47896#comment:12>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list