[wp-trac] [WordPress Trac] #38310: Improve "wp_update_term" documentation

[WordPress Trac]

#38310: Improve "wp_update_term" documentation
----------------------------------------+-----------------------------
 Reporter:  ruud@…                      |       Owner:
     Type:  enhancement                 |      Status:  new
 Priority:  normal                      |   Milestone:  Future Release
Component:  Taxonomy                    |     Version:  trunk
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs
----------------------------------------+-----------------------------
Changes (by boonebgorges):

 * keywords:  has-patch dev-feedback => needs-patch good-first-bug
 * focuses:   => docs
 * milestone:  Awaiting Review => Future Release


Comment:

 Hi @ruud at joyo - Agreed 100% that this bit of the documentation is unclear.
 Introduced in [6378].

 IMHO, the paragraph you've edited should be removed altogether:

 a. It's not actually accurate that the terms/term_taxonomy table schemas
 give any information about `$args`.
 b. `$args` should be documented as a `@param` anyway. It already is,
 though it a lackluster and apparently incorrect way. I don't think these
 `$args` have anything to do with `get_terms()`.

 I think we need a new patch that removes the paragraph in question, and
 updates the `@param` documentation to be correct. You should be able to
 figure out each argument's purpose by looking at the way the
 `$parsed_args` parameter is used throughout the function (and `$defaults`
 will show you the default values).

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