Reviewed comments and type hints

src/common.py

@@ -55,6 +55,7 @@ def hf_api_token(write: bool = False) -> str:
     return token
 
 
+# Constants for the status values returned from Hugging Face
 HF_RUNNING = 'running'
 HF_SCALEDTOZERO = 'scaleToZero'
 HF_PAUSED = 'paused'
@@ -64,7 +65,8 @@ HF_FAILED = 'failed'
 def hf_endpoint_status(username: str, endpoint_name: str, api_token: str = None) -> Tuple[bool, bool]:
     """
     Utility to check the status of a hugging face inference endpoint
-    :return: tuple of booleans first is if it is available, second is if it fully shutdown.  False, True indicates it is not fully available or fully shutdown so is in process of starting up or shutting down
+    :return: tuple of booleans first is if it is available, second is if it fully shutdown.
+    False, True indicates it is not fully available or fully shutdown so is in process of starting up or shutting down
     """
     url = f'https://api.endpoints.huggingface.cloud/v2/endpoint/{username}/{endpoint_name}'
     if api_token is None:
@@ -78,6 +80,10 @@ def hf_endpoint_status(username: str, endpoint_name: str, api_token: str = None)
 
 
 def pause_hf_endpoint(username: str, endpoint_name: str, api_token: str = None) -> None:
+    """
+    Utility to pause a hf inference endpoint via API call.  Username and endpoint fully qualify the endpoing on
+    hugging face
+    """
     url = f'https://api.endpoints.huggingface.cloud/v2/endpoint/{username}/{endpoint_name}/pause'
     if api_token is None:
         api_token = hf_api_token(write=True)
@@ -85,6 +91,10 @@ def pause_hf_endpoint(username: str, endpoint_name: str, api_token: str = None)
 
 
 def resume_hf_endpoint(username: str, endpoint_name: str, api_token: str = None) -> None:
+    """
+    Utility to resume a hf inference endpoint via API call.  Username and endpoint fully qualify the endpoing on
+    hugging face
+    """
     url = f'https://api.endpoints.huggingface.cloud/v2/endpoint/{username}/{endpoint_name}/resume'
     if api_token is None:
         api_token = hf_api_token(write=True)