update docs (#335)

openclimatefix · Apr 20, 2024 · 12c1a46 · 12c1a46
1 parent 04590e7
commit 12c1a46
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/database.py b/src/database.py
@@ -386,11 +386,14 @@ def get_gsp_system(session: Session, gsp_id: Optional[int] = None) -> List[Locat
 
 def save_api_call_to_db(request, session, user=None):
     """
-    Save api call to database
+    Save API call to database
 
     If the user does not have an email address, we will save the email as unknown
-    :param request:
-    :return:
+
+    :param request: The API request object
+    :param session: The database session
+    :param user: The user object (optional)
+    :return: None
     """
 
     url = str(request.url)