fix: improve documentation and automated commit msg

ScribeLabsAI · Nov 20, 2023 · bdf18e0 · bdf18e0
1 parent 15ae5a3
commit bdf18e0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/.github/workflows/update-doc.yml b/.github/workflows/update-doc.yml
@@ -29,7 +29,7 @@ jobs:
           destination_folder: 'docs/SDK/auth-python'
           destination_base_branch: 'master'
           destination_head_branch: 'auth-python-update'
-          commit_msg: 'Update Auth Python doc'
+          commit_msg: 'docs(authPython): Update Auth Python doc'
           pr_title: 'Update Auth Python doc'
           pull_request_reviewers: 'EHadoux'
           user_email: '[email protected]'

diff --git a/scribeauth/scribeauth.py b/scribeauth/scribeauth.py
@@ -203,9 +203,12 @@ def get_tokens(self, **param) -> Tokens | Challenge:
 
         It is possible to pass a UsernamePassword or a RefreshToken:
 
-        :param UsernamePassword: username (usually an email address) and password (associated with this username).
+        :param username: Username (usually an email address).
+        :param password: Password (associated with this username).
+
+        Or
 
-        :param RefreshToken: refresh_token (refresh token to use).
+        :param refresh_token: Refresh Token to use.
 
         It returns Tokens or a Challenge: