docs(api.py, auth.py): simplify and clarify the description of refres…

…h_callback parameter in docstrings
NodeJSmith · Jul 13, 2024 · afe8959 · afe8959
1 parent 15a4dd4
commit afe8959
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 7 deletions.
diff --git a/src/otf_api/api.py b/src/otf_api/api.py
@@ -103,8 +103,7 @@ def __init__(
             access_token (str, optional): The access token. Default is None.
             id_token (str, optional): The id token. Default is None.
             user (OtfUser, optional): A user object. Default is None.
-            refresh_callback (Callable[["OtfUser"], None], optional): A callback function to run when the token is
-            refreshed. Callable should accept the user object as an argument. Default is None.
+            refresh_callback (Callable[[OtfUser], None], optional): The callback to call when the tokens are refreshed.
         """
         self.member: MemberDetail
         self.home_studio: StudioDetail
@@ -161,8 +160,7 @@ async def create(
             password (str, None): The password of the user. Default is None.
             access_token (str, None): The access token. Default is None.
             id_token (str, None): The id token. Default is None.
-            refresh_callback (Callable[["OtfUser"], None], optional): A callback function to run when the token is
-            refreshed. Callable should accept the user object as an argument. Default is None.
+            refresh_callback (Callable[[OtfUser], None], optional): The callback to call when the tokens are refreshed.
 
         Returns:
             Api: The API instance.

diff --git a/src/otf_api/auth.py b/src/otf_api/auth.py
@@ -72,7 +72,6 @@ def __init__(self, cognito: Cognito, refresh_callback: Callable[["OtfUser"], Non
         Args:
             cognito (Cognito): The Cognito instance to use.
             refresh_callback (Callable[[OtfUser], None], optional): The callback to call when the tokens are refreshed.
-            Callable should accept the user instance as an argument. Defaults to None.
         """
         self.cognito = cognito
 
@@ -106,7 +105,6 @@ def load_from_disk(
             username (str): The username to reauthenticate with.
             password (str): The password to reauthenticate with.
             refresh_callback (Callable[[OtfUser], None], optional): The callback to call when the tokens are refreshed.
-            Callable should accept the user instance as an argument. Defaults to None.
 
         Returns:
             OtfUser: The loaded user.
@@ -132,7 +130,6 @@ def login(
             username (str): The username to login with.
             password (str): The password to login with.
             refresh_callback (Callable[[OtfUser], None], optional): The callback to call when the tokens are refreshed.
-            Callable should accept the user instance as an argument. Defaults to None.
 
         Returns:
             OtfUser: The logged in user.