[wp-trac] [WordPress Trac] #34857: Improve documentation for wp_admin_css_color()

[WordPress Trac]

#34857: Improve documentation for wp_admin_css_color()
--------------------------+----------------------------------------
 Reporter:  swissspidy    |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  normal        |   Keywords:  needs-patch good-first-bug
  Focuses:  docs          |
--------------------------+----------------------------------------
 As per the `@todo` comment in `wp_admin_css_color()`, the function's
 optional parameters need some love.

 There's a usage example in the description, but from looking at the params
 alone it's not clear what exactly you can pass and what the default param
 (empty array) means. Also, the punctuation is not 100% correct.

 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/34857>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform