Skip to content
This repository has been archived by the owner on Sep 24, 2018. It is now read-only.

Adjustments to Users Controller DocBlocks #743

Merged
merged 9 commits into from
Jan 2, 2015
Merged

Conversation

rachelbaker
Copy link
Member

No description provided.

@rachelbaker
Copy link
Member Author

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

@rachelbaker rachelbaker added this to the 2.0 milestone Dec 27, 2014
@rachelbaker
Copy link
Member Author

@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
Copy link
Member

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

cc @DrewAPicture

Copy link
Contributor

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?

Copy link
Member

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 |

@danielbachhuber
Copy link
Member

Just one nit.

@rachelbaker
Copy link
Member Author

@danielbachhuber The one nit should be picked, now.

@danielbachhuber
Copy link
Member

👍

danielbachhuber added a commit that referenced this pull request Jan 2, 2015
Adjustments to Users Controller DocBlocks
@danielbachhuber danielbachhuber merged commit 3597c90 into develop Jan 2, 2015
@danielbachhuber danielbachhuber deleted the users-docblocks branch January 2, 2015 19:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants