update resmaple_file docstring

2023-09-22 12:51:21 +05:30
parent d430795d35
commit 2f2233a9af
1 changed files with 7 additions and 6 deletions
@@ -19,12 +19,13 @@ def resample(file: str, sr: int = 16000):
    # https://github.com/openai/whisper/blob/7858aa9c08d98f75575035ecd6481f462d66ca27/whisper/audio.py#L22
    Open an audio file and read as mono waveform, resampling as necessary,
    save the resampled audio
-    Parameters
-    ----------
-    file: str
-        The audio file to open
-    sr: int
-        The sample rate to resample the audio if necessary
+
+    Args:
+        file (str): The audio file to open
+        sr (int): The sample rate to resample the audio if necessary
+    
+    Returns:
+        resampled_file (str): The resampled audio file
    """
    try:
        # This launches a subprocess to decode audio while down-mixing and resampling as necessary.