Fix the syntax for some status-related documentation introduced in [30155].

* Variables in DocBlocks should be backtick-escaped
* Parameter and return types should be as specific as possible
* `@param` types and variables should align with each other, but not intentionally with the `@return` description

See #30230.


git-svn-id: https://develop.svn.wordpress.org/trunk@30284 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-11-08 20:55:14 +00:00
parent 9b425eb5e4
commit 72cc949b5d
3 changed files with 5 additions and 6 deletions

View File

@@ -1069,7 +1069,7 @@ function get_post_status_object( $post_status ) {
* @see register_post_status()
*
* @param array|string $args Optional. Array or string of post status arguments to compare against
* properties of the global $wp_post_statuses objects. Default empty array.
* properties of the global `$wp_post_statuses objects`. Default empty array.
* @param string $output Optional. The type of output to return, either 'names' or 'objects'. Default 'names'.
* @param string $operator Optional. The logical operation to perform. 'or' means only one element
* from the array needs to match; 'and' means all elements must match.