From c9e497e5cfd20378d92658b0dce5b2b0f2e719d1 Mon Sep 17 00:00:00 2001 From: HallowedDust5 Date: Tue, 21 Jun 2022 21:37:08 -0400 Subject: [PATCH] Added function comment --- video_creation/voices.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/video_creation/voices.py b/video_creation/voices.py index be7da96..aaadd42 100644 --- 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