Doc for extract_newpw

mistotebe · mistotebe · commit 8575ac15b7d7 · 2020-04-30T08:41:17.000+01:00
diff --git a/Doc/reference/ldap.rst b/Doc/reference/ldap.rst
@@ -818,7 +818,7 @@ and wait for and return with the server's result, or with
 
 .. py:method:: LDAPObject.passwd(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> int
 
-.. py:method:: LDAPObject.passwd_s(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> (respoid, respvalue)
+.. py:method:: LDAPObject.passwd_s(user, oldpw, newpw [, serverctrls=None [, clientctrls=None] [, extract_newpw=False]]]) -> (respoid, respvalue)
 
    Perform a ``LDAP Password Modify Extended Operation`` operation
    on the entry specified by *user*.
@@ -829,10 +829,12 @@ and wait for and return with the server's result, or with
    of the specified *user* which is sometimes used when a user changes
    his own password.
 
-   ``respoid`` is always :py:const:`None`. ``respvalue`` is also
-   :py:const:`None` unless *newpw* was :py:const:`None`, this requests
-   that the server generates a new random password. With :py:meth:`passwd_s()`
-   method, this password is available through ``respvalue.genPasswd``.
+   *respoid* is always :py:const:`None`. *respvalue* is also
+   :py:const:`None` unless *newpw* was :py:const:`None`. This requests that
+   the server generate a new random password. If *extract_newpw* is
+   :py:const:`True`, this password is a bytes object available through
+   ``respvalue.genPasswd``, otherwise *respvalue* is the raw ASN.1 response
+   (this is deprecated and only for backwards compatibility).
 
    *serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
 
