Skip to content

Commit 51a8bd1

Browse files
committed
Add documentation for LDAPObject.connect()
1 parent 0cce151 commit 51a8bd1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Doc/reference/ldap.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -972,6 +972,16 @@ and wait for and return with the server's result, or with
972972
The *dn* and *attr* arguments are text strings; see :ref:`bytes_mode`.
973973

974974

975+
.. py:method:: LDAPObject.connect() -> None
976+
977+
Opens a connection to the server if one is not established already. If that
978+
fails, an instance of :py:exc:`ldap.LDAPError` or appropriate subtype is
979+
raised.
980+
981+
Requires libldap 2.5+ and will fail with :py:exc:`NotImplementedError`
982+
if that is not met.
983+
984+
975985
.. py:method:: LDAPObject.delete(dn) -> int
976986
977987
.. py:method:: LDAPObject.delete_s(dn) -> None

0 commit comments

Comments
 (0)