more docs on SASL binds

ECN · Sep 5, 2017 · 0bd7f6b · 0bd7f6b
1 parent c128684
commit 0bd7f6b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/Doc/ldap-sasl.rst b/Doc/ldap-sasl.rst
@@ -1,4 +1,4 @@
-.. % $Id: ldap-sasl.rst,v 1.4 2017/08/01 17:48:00 stroeder Exp $
+.. % $Id: ldap-sasl.rst,v 1.5 2017/09/05 07:38:45 stroeder Exp $
 
 
 ***********************************************
@@ -38,19 +38,29 @@ Classes
 
 .. autoclass:: ldap.sasl.sasl
    :members:
+
+   This class is used with :py:meth:`ldap.LDAPObject.sasl_interactive_bind_s()`.
+
 
 .. autoclass:: ldap.sasl.cram_md5
    :members:
 
+
 .. autoclass:: ldap.sasl.digest_md5
    :members:
 
+
 .. autoclass:: ldap.sasl.gssapi
    :members:
 
+   You might consider using convenience method :py:meth:`ldap.LDAPObject.sasl_gssapi_bind_s()`.
+
+
 .. autoclass:: ldap.sasl.external
    :members:
 
+   You might consider using convenience method :py:meth:`ldap.LDAPObject.sasl_external_bind_s()`.
+
 
 .. _ldap.sasl-example:
 

diff --git a/Doc/ldap.rst b/Doc/ldap.rst
@@ -1,4 +1,4 @@
-.. % $Id: ldap.rst,v 1.41 2017/09/05 07:23:36 stroeder Exp $
+.. % $Id: ldap.rst,v 1.42 2017/09/05 07:38:46 stroeder Exp $
 
 ********************************************
 :py:mod:`ldap` LDAP library interface module
@@ -935,6 +935,8 @@ and wait for and return with the server's result, or with
 .. py:method:: LDAPObject.sasl_interactive_bind_s(who, auth[, serverctrls=None [, clientctrls=None [, sasl_flags=ldap.SASL_QUIET]]]) -> None
 
    This call is used to bind to the directory with a SASL bind request.
+
+   *auth* is an :py:class:`ldap.sasl.sasl()` instance.
 
    *serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.