[Snorkell.ai] Please review the generated documentation for commit - c1d56d2

src/azure_devops.py

@@ -9,6 +9,15 @@
 # base_url = "https://f0a8-2401-4900-1f26-31a3-b5b1-65c0-2624-a5e9.ngrok-free.app"
 
 async def notify_error(message):
+    """    Notify about an error to the GithubClient.
+
+    Args:
+        message (str): The error message to be notified.
+
+    Returns:
+        None
+    """
+
     message = f"GithubClient alert:\n {message}"
     print(message)
     other_vars = {
@@ -53,6 +62,20 @@ async def initiate_documentation_generation(
 
 
 async def check_documentation_generation_status(headers, data):
+    """    Check the status of documentation generation.
+
+    Args:
+        headers (dict): The headers to be included in the request.
+        data (dict): The data to be sent in the request.
+
+    Returns:
+        None
+
+    Raises:
+        Exception: If the request to the API fails or times out.
+        Exception: If the documentation generation fails.
+    """
+
     url = f"{base_url}/api/app/azDevops/status/documentation"
     count = 0
     while count < 360: