From 645d1c49c0aa45fa714f244d1374ea0e33d11d90 Mon Sep 17 00:00:00 2001
From: codey <codey@code.ee>
Date: Sun, 19 Jan 2025 07:05:01 -0500
Subject: [PATCH] missed docstring

---
 lyric_search_new/sources/redis_cache.py | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

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: