Clean up docstrings across files

src/app.py

@@ -4,16 +4,18 @@ app.py
 Gradio UI for interacting with the Anthropic API, Hume TTS API, and ElevenLabs TTS API.
 
 Users enter a prompt, which is processed using Claude by Anthropic to generate text.
-The text is then synthesized into speech using both Hume and ElevenLabs TTS APIs.
-Users can compare the outputs in an interactive UI.
+The text is then synthesized into speech using both Hume and ElevenLabs text-to-speech (TTS) APIs.
+Users can compare the outputs and vote for their favorite in an interactive UI.
 """
 
 # Standard Library Imports
 from concurrent.futures import ThreadPoolExecutor
 import random
 from typing import Union, Tuple
+
 # Third-Party Library Imports
 import gradio as gr
+
 # Local Application Imports
 from src.config import logger
 from src.constants import (

src/config.py

@@ -12,6 +12,7 @@ Key Features:
 # Standard Library Imports
 import logging
 import os
+
 # Third-Party Library Imports
 from dotenv import load_dotenv
 

src/constants.py

@@ -4,11 +4,9 @@ constants.py
 This module defines global constants used throughout the project.
 """
 
-# Minimum and maximum prompt length constraints
+# UI constants
 PROMPT_MIN_LENGTH: int = 10
 PROMPT_MAX_LENGTH: int = 300
-
-# Vote button constants
 OPTION_ONE: str = "Option 1"
 OPTION_TWO: str = "Option 2"
 TROPHY_EMOJI = "🏆"

src/integrations/anthropic_api.py

@@ -1,9 +1,8 @@
 """
 anthropic_api.py
 
-This file defines the interaction with the Anthropic API, focusing on generating text
-using the Claude model. It includes functionality for input validation, API request handling,
-and processing API responses.
+This file defines the interaction with the Anthropic API, focusing on generating text using the Claude model. 
+It includes functionality for input validation, API request handling, and processing API responses.
 
 Key Features:
 - Encapsulates all logic related to the Anthropic API.
@@ -23,10 +22,12 @@ Functions:
 from dataclasses import dataclass
 import logging
 from typing import List, Optional, Union
+
 # Third-Party Library Imports
 from anthropic import Anthropic
 from anthropic.types import Message, ModelParam, TextBlock
 from tenacity import retry, stop_after_attempt, wait_fixed, before_log, after_log
+
 # Local Application Imports
 from src.config import logger
 from src.utils import truncate_text, validate_env_var

src/integrations/elevenlabs_api.py

@@ -12,7 +12,7 @@ Key Features:
 
 Classes:
 - ElevenLabsConfig: Immutable configuration for interacting with the TTS API.
-- ElevenLabsError: Custom exception for TTS API-related errors.
+- ElevenLabsError: Custom exception for ElevenLabs API-related errors.
 
 Functions:
 - text_to_speech_with_elevenlabs: Converts text to speech using the ElevenLabs TTS API.
@@ -23,9 +23,11 @@ from dataclasses import dataclass
 import logging
 import random
 from typing import Optional
+
 # Third-Party Library Imports
 from elevenlabs import ElevenLabs
 from tenacity import retry, stop_after_attempt, wait_fixed, before_log, after_log
+
 # Local Application Imports
 from src.config import logger
 from src.utils import validate_env_var, truncate_text

src/integrations/hume_api.py

@@ -12,7 +12,7 @@ Key Features:
 
 Classes:
 - HumeConfig: Immutable configuration for interacting with the TTS API.
-- HumeError: Custom exception for TTS API-related errors.
+- HumeError: Custom exception for Hume API-related errors.
 
 Functions:
 - text_to_speech_with_hume: Converts text to speech using the Hume TTS API with input validation and retry logic.
@@ -23,9 +23,11 @@ from dataclasses import dataclass
 import logging
 import random
 from typing import List, Optional
+
 # Third-Party Library Imports
 import requests
 from tenacity import retry, stop_after_attempt, wait_fixed, before_log, after_log
+
 # Local Application Imports
 from src.config import logger
 from src.utils import validate_env_var, truncate_text

src/theme.py

@@ -2,21 +2,14 @@
 theme.py
 
 Defines a custom Gradio theme.
-
-This module creates a `CustomTheme` class, inheriting from `gradio.themes.base.Base`,
-and overrides default styling variables. It uses CSS variables for consistency
-with the application's styling.
-
-Key Features:
-- Defines a color palette using CSS variables.
-- Customizes styling for Gradio components (buttons, inputs, etc.).
-- Adjusts shadows, borders, and gradients.
-- Supports light and dark modes.
+- For more information on Gradio themes see: https://www.gradio.app/docs/gradio/themes
+- For manual styling with css, see /src/assets/styles.css
 """
 
 # Standard Library Imports
 from __future__ import annotations
 from collections.abc import Iterable
+
 # Third-Party Library Imports
 from gradio.themes.base import Base
 from gradio.themes.utils import colors, fonts, sizes
@@ -64,16 +57,13 @@ class CustomTheme(Base):
             error_border_color_dark='#EF4444',  
             error_icon_color='#B91C1C',  
             error_icon_color_dark='#EF4444',  
-
             # Shadows
             input_shadow_focus='0 0 0 *shadow_spread #7C3AED80, *shadow_inset',  
             input_shadow_focus_dark='0 0 0 *shadow_spread #40404080, *shadow_inset',  
-
             # Button borders
             button_border_width='0px',
             input_border_width='1px',
             input_background_fill='#F9FAFB',  
-
             # Gradients
             stat_background_fill='linear-gradient(to right, #7C3AED, #D8B4FE)',
             stat_background_fill_dark='linear-gradient(to right, #7C3AED, #5B21B6)',
@@ -81,7 +71,6 @@ class CustomTheme(Base):
             checkbox_label_background_fill_dark='#1F2937',
             checkbox_label_background_fill_hover='#E5E7EB',
             checkbox_label_background_fill_hover_dark='#374151',
-
             # Primary Button
             button_primary_background_fill='#111111',  
             button_primary_background_fill_dark='#171717',  
@@ -89,7 +78,6 @@ class CustomTheme(Base):
             button_primary_background_fill_hover_dark='#3F3F3F',  
             button_primary_text_color='#FFFFFF',  
             button_primary_text_color_dark='#FFFFFF',  
-
             # Secondary Button
             button_secondary_background_fill='#E5E7EB',  
             button_secondary_background_fill_dark='#4B5563',  
@@ -97,7 +85,6 @@ class CustomTheme(Base):
             button_secondary_background_fill_hover_dark='#374151',  
             button_secondary_text_color='#111827',  
             button_secondary_text_color_dark='#FFFFFF',  
-
             # Cancel Button
             button_cancel_background_fill='#EF4444',  
             button_cancel_background_fill_dark='#B91C1C',  
@@ -107,7 +94,6 @@ class CustomTheme(Base):
             button_cancel_text_color_dark='#FFFFFF',  
             button_cancel_text_color_hover='#FFFFFF',  
             button_cancel_text_color_hover_dark='#FFFFFF',  
-
             # Other
             border_color_accent_subdued='#A78BFA',  
         )

src/utils.py

@@ -4,18 +4,15 @@ utils.py
 This file contains utility functions that are shared across the project.
 These functions provide reusable logic to simplify code in other modules.
 
-Key Features:
-- Validates that required environment variables are set, raising meaningful errors otherwise.
-- Provides helper functions for text validation and truncation.
-
 Functions:
-- truncate_text: Truncates a string to a specified length with ellipses.
+- truncate_text: Truncates a string to a specified length with ellipses. (used for logging)
 - validate_env_var: Ensures the presence of a specific environment variable and retrieves its value.
-- validate_prompt_length: Ensures that a prompt does not exceed the specified maximum length.
+- validate_prompt_length: Ensures that a prompt does not exceed the specified minimum or maximum length.
 """
 
 # Standard Library Imports
 import os
+
 # Local Application Imports
 from src.config import logger
 
@@ -104,18 +101,14 @@ def validate_prompt_length(prompt: str, max_length: int, min_length: int) -> Non
     
     logger.debug(f'Prompt length being validated: {prompt_length} characters')
 
-    # Check if prompt is too short
     if prompt_length < min_length:
         raise ValueError(
             f'Your prompt is too short. Please enter at least {min_length} characters. '
             f'(Current length: {prompt_length})'
         )
-
-    # Check if prompt exceeds max length
     if prompt_length > max_length:
         raise ValueError(
             f'Your prompt is too long. Please limit it to {max_length} characters. '
             f'(Current length: {prompt_length})'
         )
-
     logger.debug(f'Prompt length validation passed for prompt: {truncate_text(stripped_prompt)}')