From c7ce0a4d55daa4974dcb92156f6f1df7aea5a092 Mon Sep 17 00:00:00 2001
From: Scott Taylor <wonderboymusic@git.wordpress.org>
Date: Sun, 30 Nov 2014 22:10:12 +0000
Subject: [PATCH] Improve the `@param` docs for `src/wp-includes/user.php`.

See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30666 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/user.php | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php
index f3bcb08cf4..0502578d82 100644
--- a/src/wp-includes/user.php
+++ b/src/wp-includes/user.php
@@ -19,8 +19,8 @@
  *
  * @since 2.5.0
  *
- * @param array $credentials Optional. User info in order to sign on.
- * @param bool $secure_cookie Optional. Whether to use secure cookie.
+ * @param array       $credentials   Optional. User info in order to sign on.
+ * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
  */
 function wp_signon( $credentials = array(), $secure_cookie = '' ) {
@@ -229,7 +229,7 @@ function wp_authenticate_spam_check( $user ) {
  *
  * @since 3.9.0
  *
- * @param int|bool $user The user ID (or false) as received from the
+ * @param int|bool $user_id The user ID (or false) as received from the
  *                       determine_current_user filter.
  * @return int|bool User ID if validated, false otherwise. If a user ID from
  *                  an earlier filter callback is received, that value is returned.
@@ -345,7 +345,7 @@ function get_current_user_id() {
  *
  * @param string $option     User option name.
  * @param int    $user       Optional. User ID.
- * @param bool   $deprecated Use get_option() to check for an option in the options table.
+ * @param string $deprecated Use get_option() to check for an option in the options table.
  * @return mixed User option value on success, false on failure.
  */
 function get_user_option( $option, $user = 0, $deprecated = '' ) {
@@ -485,7 +485,7 @@ class WP_User_Query {
 	 *
 	 * @since 3.1.0
 	 *
-	 * @param string|array $args Optional. The query variables.
+	 * @param null|string|array $args Optional. The query variables.
 	 * @return WP_User_Query
 	 */
 	public function __construct( $query = null ) {
@@ -2040,7 +2040,7 @@ function wp_create_user($username, $password, $email = '') {
  * @since 3.3.0
  * @access private
  *
- * @param object $user WP_User instance.
+ * @param WP_User $user WP_User instance.
  * @return array
  */
 function _get_additional_user_keys( $user ) {