Improve docstrings

Signed-off-by: JoeLametta <JoeLametta@users.noreply.github.com>
2019-03-20 21:12:56 +00:00
parent 3b269e7a3b
commit e56c636fd3
26 changed files with 583 additions and 488 deletions
--- a/whipper/program/sox.py
+++ b/whipper/program/sox.py
@@ -9,10 +9,10 @@ SOX = 'sox'

 def peak_level(track_path):
    """
-    Accepts a path to a sox-decodable audio file.
+    Accept a path to a sox-decodable audio file.

-    Returns track peak level from sox ('maximum amplitude') as a float.
-    Returns None on error.
+    :returns: track peak level from sox ('maximum amplitude')
+    :rtype: float or None
    """
    if not os.path.exists(track_path):
        logger.warning("SoX peak detection failed: file not found")