From bf06cb62adb5c68da296122619bb39152e24791b Mon Sep 17 00:00:00 2001
From: HallowedDust5 <ashibrahim16@yahoo.com>
Date: Wed, 15 Jun 2022 14:15:40 -0400
Subject: [PATCH] Added documentation

---
 video_creation/voices.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/video_creation/voices.py b/video_creation/voices.py
index c0df8b7..6d81cb3 100644
--- a/video_creation/voices.py
+++ b/video_creation/voices.py
@@ -6,11 +6,15 @@ from rich.progress import track
 
 
 def save_text_to_mp3(reddit_obj):
-    """Saves Text to MP3 files.
+    """Saves Text to MP3 files
 
     Args:
-        reddit_obj : The reddit object you received from the reddit API in the askreddit.py file.
-    """
+        reddit_obj (dict): Reddit object given by get_subreddit_threads
+
+    Returns:
+        tuple[int,int]: First index is the length of comments used, I don't know what idx is
+    """        
+
     print_step("Saving Text to MP3 files...")
     length = 0