diff --git a/lyric_search_new/sources/redis_cache.py b/lyric_search_new/sources/redis_cache.py index 69d9263..7182f41 100644 --- a/lyric_search_new/sources/redis_cache.py +++ b/lyric_search_new/sources/redis_cache.py @@ -52,10 +52,14 @@ class RedisCache: await self.notifier.send(f"ERROR @ {__file__}", f"Failed to create idx: {str(e)}") async def search(self, **kwargs): - """Search Redis Cache - @artist: artist to search - @song: song to search - @lyrics: lyrics to search (optional, used in place of artist/song if provided) + """ + Search Redis Cache + Args: + artist (Optional[str]): artist to search + song (Optional[str]): song to search + lyrics (Optional[str]): lyrics to search (optional, used in place of artist/song if provided) + Returns: + list[tuple]: List of redis results, tuple's first value is the redis key, second is the returned data """ try: