Improve documentation for wp_admin_css_color()

[swissspidy]

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 ​PHP documentation standards for more details.

[kiranpotphode]

$colors array does not have any keys but accepts four parameters. So hash notations for $colors argument are missing key|value.

[kiranpotphode]

Any guidelines on hash notations where arguments have no key-value pair but accepts definite number of parameters?
For example in this case $colors argument accepts 4 parameters but lacks keys for parameters.

[swissspidy]

Any guidelines on hash notations where arguments have no key-value pair but accepts definite number of parameters?

For example in this case $colors argument accepts 4 parameters but lacks keys for parameters.

@DrewAPicture to the rescue? :-)

[DrewAPicture]

Replying to swissspidy:

Any guidelines on hash notations where arguments have no key-value pair but accepts definite number of parameters?

For example in this case $colors argument accepts 4 parameters but lacks keys for parameters.

@DrewAPicture to the rescue? :-)

We don't document flat arrays in hash notations. I would suggest documenting the accepted values, types, and exact order required in the parameter description.

[swissspidy]

@kiranpotphode Do you have time to update the patch as per the suggestions above?

[kiranpotphode]

Documented flat array as suggested. Uploaded updated patch.

[SergeyBiryukov]

In 36107:

Docs: Improve documentation for wp_admin_css_color().

Props kiranpotphode.
Fixes #34857.