From 4cbd0fb934079cd28117a2ea76714c2c8257c2be Mon Sep 17 00:00:00 2001 From: codey Date: Mon, 11 Aug 2025 14:06:42 -0400 Subject: [PATCH] docstrings --- utils/sr_wrapper.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/utils/sr_wrapper.py b/utils/sr_wrapper.py index 1909502..aa6242a 100644 --- a/utils/sr_wrapper.py +++ b/utils/sr_wrapper.py @@ -54,7 +54,7 @@ class SRUtil: return f"{m}:{s:02}" async def get_artists_by_name(self, artist_name: str) -> Optional[list]: - """Get artist(s) by name from HiFi API. + """Get artist(s) by name. Args: artist_name (str): The name of the artist. Returns: @@ -89,7 +89,7 @@ class SRUtil: return artists_out async def get_albums_by_artist_id(self, artist_id: int) -> Optional[list | dict]: - """Get albums by artist ID from HiFi API. + """Get albums by artist ID Args: artist_id (int): The ID of the artist. Returns: @@ -127,7 +127,7 @@ class SRUtil: return albums_out async def get_tracks_by_album_id(self, album_id: int) -> Optional[list | dict]: - """Get tracks by album ID from HiFi API. + """Get tracks by album ID Args: album_id (int): The ID of the album. Returns: @@ -158,7 +158,7 @@ class SRUtil: return tracks_out async def get_tracks_by_artist_song(self, artist: str, song: str) -> Optional[list]: - """Get track by artist and song name from HiFi API. + """Get track by artist and song name Args: artist (str): The name of the artist. song (str): The name of the song. @@ -171,7 +171,7 @@ class SRUtil: async def get_stream_url_by_track_id( self, track_id: int, quality: str = "LOSSLESS" ) -> Optional[str]: - """Get stream URL by track ID from HiFi API. + """Get stream URL by track ID Args: track_id (int): The ID of the track. quality (str): The quality of the stream, default is "LOSSLESS". Other options: HIGH, LOW