Document wp_delete_term() $args as a hash notation

[swissspidy]

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

[slushman]

Changed PHPDoc for $args to use hash notation.

[swissspidy]

34862.diff​ is a small update to the provided patch, moving the description from the DocBlock to the $args description. Also removing the @todo and improving the docs for @return.

[DrewAPicture]

34862.diff​ looks great. The only thing missing a description of the default for the optional parameter. You can add it to the end of the description:

*    Optional. Array of arguments to override the default term ID. Default empty array.

[DrewAPicture]

In 35889:

Docs: Document the optional $args parameter in wp_delete_term() in the hash notation style.

Props slushman, swissspidy.
Fixes #34862.