-
Notifications
You must be signed in to change notification settings - Fork 658
Adjustments to Users Controller DocBlocks #743
Conversation
Cleaning up DocBlocks related to the Users Controller. Fixes 23 Scrutizer Issues: https://scrutinizer-ci.com/g/WP-API/WP-API/inspections/dede1b90-077f-4fc6-a9f6-2979c7f09043/issues/?status=fixed |
@WP-API/amigos #reviewmerge |
@@ -187,7 +192,7 @@ public function update_item( $request ) { | |||
* Delete a single user | |||
* | |||
* @param WP_JSON_Request $request Full details about the request | |||
* @return array|WP_Error | |||
* @return mixed WP_Error or WP_JSON_Response |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although the documentation standards don't seem to communicate this, I think the way we already have it is proper WordPress formatting: https://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-functions-and-class-methods
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems to be fine. Only nit is that all tag descriptions should be treated as sentences, thus first-letter capitals and periods.
We've also been trying to avoid specifying types as 'mixed' unless it's something like a meta value that could accept almost anything. Specificity is almost always preferred. Did I miss anything?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nah, seems good. Just wanted the sanity check on the |
Just one nit. |
@danielbachhuber The one nit should be picked, now. |
👍 |
Adjustments to Users Controller DocBlocks
No description provided.