Add docstrings to auth.oauth() and auth.service_account()

burnash · Apr 28, 2020 · 326667c · 326667c
1 parent a756dd6
commit 326667c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -7,6 +7,7 @@ Top level
 ---------
 
 .. autofunction:: oauth
+.. autofunction:: service_account
 .. autofunction:: authorize
 
 Client

diff --git a/gspread/auth.py b/gspread/auth.py
@@ -88,6 +88,13 @@ def store_credentials(
 
 
 def oauth(scopes=DEFAULT_SCOPES, flow=local_server_flow):
+    """Authenticate with OAuth Client ID.
+
+    :param list scopes: The scopes used to obtain authorization.
+    :param function flow: OAuth flow to use for authentication.
+
+    :rtype: :class:`gspread.client.Client`
+    """
     creds = load_credentials()
 
     if not creds:
@@ -101,6 +108,13 @@ def oauth(scopes=DEFAULT_SCOPES, flow=local_server_flow):
 def service_account(
     filename=DEFAULT_SERVICE_ACCOUNT_FILENAME, scopes=DEFAULT_SCOPES
 ):
+    """Authenticate using a service account.
+
+    :param str filename: The path to the service account json file.
+    :param list scopes: The scopes used to obtain authorization.
+
+    :rtype: :class:`gspread.client.Client`
+    """
     creds = ServiceAccountCredentials.from_service_account_file(
         filename, scopes=scopes
     )