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

[WordPress Trac]

#38310: Improve "wp_update_term" documentation
-------------------------------------------------+-------------------------
 Reporter:  ruud@…                               |       Owner:  ruudjoyo
     Type:  enhancement                          |      Status:  assigned
 Priority:  normal                               |   Milestone:  Future
Component:  Taxonomy                             |  Release
 Severity:  normal                               |     Version:  4.7
 Keywords:  good-first-bug has-patch dev-        |  Resolution:
  feedback needs-testing                         |     Focuses:  docs
-------------------------------------------------+-------------------------

Comment (by DrewAPicture):

 Replying to [comment:7 ruud@…]:
 > Indeed, I'm not a big fan of mentioning things in the docs which
 might/could happen if used in some way etc. Stating what a function does
 do, seems a much more prudent way. Adding some more clarification in the
 @params could help?

 The value in occasionally describing what ''could'' happen is when one
 piece of functionality is commonly used with another and discrepancies
 (that we can't necessarily f ix) cause behavior perceived as unexpected.

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