Added function comment

2 years ago · c9e497e5cf
parent e23a150cd6
commit c9e497e5cf
1 changed files with 6 additions and 2 deletions
--- a/video_creation/voices.py
+++ b/video_creation/voices.py
@ -20,9 +20,13 @@ VIDEO_LENGTH: int = 40  # secs


 def save_text_to_mp3(reddit_obj):
-    """Saves Text to MP3 files.
+    """Saves text to MP3 files. Goes through the reddit_obj and generates the title MP3 file and a certain number of comments until the total amount of time exceeds VIDEO_LENGTH seconds.
+
    Args:
-            reddit_obj : The reddit object you received from the reddit API in the askreddit.py file.
+        reddit_obj (dict[str]): Reddit object received from reddit API in askreddit.py
+
+    Returns:
+        tuple[int,int]: (total length of the audio, the number of comments audio was generated for)
    """
    print_step("Saving Text to MP3 files...")
    length = 0