📝 Updated README and docstrings

Author: jemrobinson

README.md

@@ -26,10 +26,10 @@ To do this, you will need to provide the `--redis-host` and `--redis-port` argum
 
 ### Configure background refresh [Optional]
 
-By default Apricot will refresh on demand when the data is older than 60 seconds.
-If it takes a long time to fetch all users and groups, or you want to ensure that each request prompty gets a respose, you may want to configure background refresh to have it periodically be refreshed in the background.
+By default Apricot will refresh the LDAP tree whenever it is accessed and it contains data older than 60 seconds.
+If it takes a long time to fetch all users and groups, or you want to ensure that each request gets a prompt response, you may want to configure background refresh to have it periodically be refreshed in the background.
 
-This is enabled with the `--background-refresh` flag, which uses the `--refresh-interval=60` parameter as the interval to refresh the ldap database. 
+This is enabled with the `--background-refresh` flag, which uses the `--refresh-interval` parameter as the interval to refresh the ldap database.
 
 ### Using TLS [Optional]
 

apricot/ldap/oauth_ldap_server_factory.py

@@ -12,9 +12,13 @@ def __init__(
         self, domain: str, oauth_client: OAuthClient, *, background_refresh: bool, enable_mirrored_groups: bool, refresh_interval: int,
     ):
         """
-        Initialise an LDAPServerFactory
+        Initialise an OAuthLDAPServerFactory
 
+        @param background_refresh: Whether to refresh the LDAP tree in the background rather than on access
+        @param domain: The root domain of the LDAP tree
+        @param enable_mirrored_groups: Create a mirrored LDAP group-of-groups for each group-of-users
         @param oauth_client: An OAuth client used to construct the LDAP tree
+        @param refresh_interval: Interval in seconds after which the tree must be refreshed
         """
         # Create an LDAP lookup tree
         self.adaptor = OAuthLDAPTree(

apricot/ldap/oauth_ldap_tree.py

@@ -25,7 +25,9 @@ def __init__(
         """
         Initialise an OAuthLDAPTree
 
+        @param background_refresh: Whether to refresh the LDAP tree in the background rather than on access
         @param domain: The root domain of the LDAP tree
+        @param enable_mirrored_groups: Create a mirrored LDAP group-of-groups for each group-of-users
         @param oauth_client: An OAuth client used to construct the LDAP tree
         @param refresh_interval: Interval in seconds after which the tree must be refreshed
         """

apricot/oauth/oauth_data_adaptor.py

@@ -24,6 +24,13 @@ class OAuthDataAdaptor:
     def __init__(
         self, domain: str, oauth_client: OAuthClient, *, enable_mirrored_groups: bool
     ):
+        """
+        Initialise an OAuthDataAdaptor
+
+        @param domain: The root domain of the LDAP tree
+        @param enable_mirrored_groups: Create a mirrored LDAP group-of-groups for each group-of-users
+        @param oauth_client: An OAuth client used to construct the LDAP tree
+        """
         self.debug = oauth_client.debug
         self.oauth_client = oauth_client
         self.root_dn = "DC=" + domain.replace(".", ",DC=")