docstrings / formatting

endpoints/transcriptions.py

@@ -13,6 +13,7 @@ class Transcriptions(FastAPI):
     """
 
     def __init__(self, app: FastAPI, util, constants) -> None:
+        """Initialize Transcriptions endpoints."""
         self.app: FastAPI = app
         self.util = util
         self.constants = constants
@@ -36,8 +37,13 @@ class Transcriptions(FastAPI):
         self, data: ValidShowEpisodeListRequest
     ) -> JSONResponse:
         """
-        Get list of episodes by show id
-        - **s**: Show ID to query
+        Get list of episodes by show ID.
+
+        Parameters:
+        - **data** (ValidShowEpisodeListRequest): Request containing show ID.
+
+        Returns:
+        - **JSONResponse**: Contains a list of episodes.
         """
         show_id: int = data.s
         db_path: Optional[Union[str, LiteralString]] = None
@@ -106,9 +112,13 @@ class Transcriptions(FastAPI):
         self, data: ValidShowEpisodeLineRequest
     ) -> Response:
         """
-        Get lines for a particular episode
-        - **s**: Show ID to query
-        - **e**: Episode ID to query
+        Get lines for a particular episode.
+
+        Parameters:
+        - **data** (ValidShowEpisodeLineRequest): Request containing show and episode ID.
+
+        Returns:
+        - **Response**: Episode lines.
         """
         show_id: int = int(data.s)
         episode_id: int = int(data.e)