📝 Add docstrings to codex/add-lru_cache-for-get_settings-helper (#38)

Docstrings generation was requested by @shayancoin.

* #23 (comment)

The following files were modified:

* `backend/api/config.py`
* `backend/api/routes_sync.py`

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: coderabbitai[bot]

backend/api/config.py

@@ -48,23 +48,32 @@ class Settings(BaseSettings):
 
 @lru_cache()
 def get_settings() -> Settings:
-    """Return a cached instance of :class:`Settings`."""
+    """
+    Provide the application Settings instance and reuse the same instance across calls.
+    
+    Returns:
+        Settings: The Settings instance loaded from environment variables; subsequent calls return the cached same instance.
+    """
 
     return Settings()
 
 
 def get_fastapi_settings() -> Dict[str, Any]:
-    """Get FastAPI application settings.
-
-    Returns
-    -------
-    Dict[str, Any]
-        Dictionary with FastAPI settings.
+    """
+    Provide FastAPI application metadata and routing configuration for documentation UIs.
+    
+    Returns:
+        fastapi_settings (Dict[str, Any]): Mapping containing:
+            - title: API display title.
+            - description: Short API description.
+            - version: API semantic version string.
+            - docs_url: URL path for the Swagger UI.
+            - redoc_url: URL path for the ReDoc UI.
     """
     return {
         "title": "MVP API",
         "description": "API for MVP application",
         "version": "0.1.0",
         "docs_url": "/docs",
         "redoc_url": "/redoc",
-    }
+    }

backend/api/routes_sync.py

@@ -39,10 +39,26 @@
 
 
 def get_hygraph_service() -> HygraphService:
-    """Provide the shared Hygraph service instance."""
+    """
+    Provide the module-level shared HygraphService singleton.
+    
+    Returns:
+        HygraphService: The shared HygraphService instance.
+    """
 
     return _hygraph_service
 def _error_envelope(code: str, message: str, details: Optional[dict] = None) -> Dict[str, Any]:
+    """
+    Builds a standardized error envelope for API responses.
+    
+    Parameters:
+        code (str): Machine-readable error code identifying the error.
+        message (str): Human-readable error message describing the failure.
+        details (Optional[dict]): Additional contextual information; defaults to an empty dict when not provided.
+    
+    Returns:
+        Dict[str, Any]: Dictionary with keys `ok` (False) and `error` containing `code`, `message`, and `details`.
+    """
     return {"ok": False, "error": {"code": code, "message": message, "details": details or {}}}