From 1f33c5b66fd677ef8bbe574739b4dfaa931b5638 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Tue, 2 Feb 2021 12:41:22 +0000
Subject: [PATCH] Docs: Update documentation for `retrieve_password()` per the
 documentation standards.

Follow-up to [50129], [50140].

See #34281.

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

diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php
index e0127f440f..7e97e1fa9b 100644
--- a/src/wp-includes/user.php
+++ b/src/wp-includes/user.php
@@ -2664,8 +2664,8 @@ function check_password_reset_key( $key, $login ) {
  * @global wpdb         $wpdb       WordPress database abstraction object.
  * @global PasswordHash $wp_hasher  Portable PHP password hashing framework.
  *
- * @param  string       $user_login Optional user_login, default null. Uses
- *                                  `$_POST['user_login']` if `$user_login` not set.
+ * @param string $user_login Optional. Username to send a password retrieval email for.
+ *                           Defaults to `$_POST['user_login']` if not set.
  * @return true|WP_Error True when finished, WP_Error object on error.
  */
 function retrieve_password( $user_login = null ) {