[wp-trac] [WordPress Trac] #34862: Document wp_delete_term() $args as a hash notation
WordPress Trac
noreply at wordpress.org
Sun Dec 6 16:27:57 UTC 2015
#34862: Document wp_delete_term() $args as a hash notation
--------------------------+----------------------------------------
Reporter: swissspidy | Owner:
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Taxonomy | Version:
Severity: normal | Keywords: needs-patch good-first-bug
Focuses: docs |
--------------------------+----------------------------------------
As per the `@todo` comment in `wp_delete_term()`, the `$args` parameter
should be documented using hash notation.
Currently the param is only somewhat documented in the function
description. Without looking at the code closely you have no idea what it
is for. The hash notation would make it a lot more readable.
I guess the docblock deservers some overall improvements anyway.
See the [https://make.wordpress.org/core/handbook/best-practices/inline-
documentation-standards/php/#docblock-formatting PHP documentation
standards] for more details.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/34862>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list