docstrings / formatting

endpoints/lastfm.py

@@ -17,6 +17,7 @@ class LastFM(FastAPI):
     """Last.FM Endpoints"""
 
     def __init__(self, app: FastAPI, util, constants) -> None:
+        """Initialize LastFM endpoints."""
         self.app: FastAPI = app
         self.util = util
         self.constants = constants
@@ -44,8 +45,13 @@ class LastFM(FastAPI):
         self, data: ValidArtistSearchRequest
     ) -> JSONResponse:
         """
-        Get artist info
-        - **a**: Artist to search
+        Get artist information by name.
+
+        Parameters:
+        - **data** (ValidArtistSearchRequest): Request containing artist name.
+
+        Returns:
+        - **JSONResponse**: Contains artist information or an error message.
         """
         artist: Optional[str] = data.a.strip()
         if not artist:
@@ -81,8 +87,13 @@ class LastFM(FastAPI):
         self, data: ValidArtistSearchRequest
     ) -> JSONResponse:
         """
-        Get artist's albums/releases
-        - **a**: Artist to search
+        Get artist's albums/releases.
+
+        Parameters:
+        - **data** (ValidArtistSearchRequest): Request containing artist name.
+
+        Returns:
+        - **JSONResponse**: Contains a list of albums or an error message.
         """
         artist: str = data.a.strip()
         if not artist:
@@ -121,9 +132,13 @@ class LastFM(FastAPI):
         self, data: ValidAlbumDetailRequest
     ) -> JSONResponse:
         """
-        Get details of a particular release by an artist
-        - **a**: Artist to search
-        - **release**: Release title to search
+        Get details of a particular release by an artist.
+
+        Parameters:
+        - **data** (ValidAlbumDetailRequest): Request containing artist and release name.
+
+        Returns:
+        - **JSONResponse**: Release details or error.
         """
         artist: str = data.a.strip()
         release: str = data.release.strip()
@@ -157,9 +172,13 @@ class LastFM(FastAPI):
         self, data: ValidAlbumDetailRequest
     ) -> JSONResponse:
         """
-        Get track list for a particular release by an artist
-        - **a**: Artist to search
-        - **release**: Release title to search
+        Get track list for a particular release by an artist.
+
+        Parameters:
+        - **data** (ValidAlbumDetailRequest): Request containing artist and release name.
+
+        Returns:
+        - **JSONResponse**: Track list or error.
         """
         artist: str = data.a.strip()
         release: str = data.release.strip()
@@ -189,9 +208,13 @@ class LastFM(FastAPI):
 
     async def track_info_handler(self, data: ValidTrackInfoRequest) -> JSONResponse:
         """
-        Get track info from Last.FM given an artist/track
-        - **a**: Artist to search
-        - **t**: Track title to search
+        Get track info from Last.FM given an artist/track.
+
+        Parameters:
+        - **data** (ValidTrackInfoRequest): Request containing artist and track name.
+
+        Returns:
+        - **JSONResponse**: Track info or error.
         """
         try:
             artist: str = data.a