docs: add get_connection docstring

jupyterhub · Sep 16, 2024 · 537d012 · 537d012
1 parent d6178bc
commit 537d012
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ldapauthenticator/ldapauthenticator.py b/ldapauthenticator/ldapauthenticator.py
@@ -365,6 +365,11 @@ def resolve_username(self, username_supplied_by_user):
         return (user_dn, response[0]["dn"])
 
     def get_connection(self, userdn, password):
+        """
+        Returns a ldap3 Connection object automatically bound to the user.
+
+        ldap3 Connection ref: https://ldap3.readthedocs.io/en/latest/connection.html
+        """
         if self.tls_strategy == TlsStrategy.on_connect:
             use_ssl = True
             auto_bind = ldap3.AUTO_BIND_NO_TLS