diff auditok/exceptions.py @ 368:683c98b7f5a6

Put documentation in numpy style
author Amine Sehili <amine.sehili@gmail.com>
date Sun, 10 Jan 2021 17:11:07 +0100
parents 9741b52f194a
children 954c1e279068
line wrap: on
line diff
--- a/auditok/exceptions.py	Sun Jan 03 18:46:40 2021 +0100
+++ b/auditok/exceptions.py	Sun Jan 10 17:11:07 2021 +0100
@@ -3,7 +3,7 @@
 
 
 class TooSamllBlockDuration(ValueError):
-    """Raised when block_dur results in a block_size smaller than one sample"""
+    """Raised when block_dur results in a block_size smaller than one sample."""
 
     def __init__(self, message, block_dur, sampling_rate):
         self.block_dur = block_dur
@@ -12,12 +12,12 @@
 
 
 class TimeFormatError(Exception):
-    """Raised when duration formatting directicve is wrong"""
+    """Raised when a duration formatting directive is unknown."""
 
 
 class EndOfProcessing(Exception):
     """Raised within command line script's main function to jump to
-    postprocessing code"""
+    postprocessing code."""
 
 
 class AudioIOError(Exception):
@@ -28,7 +28,7 @@
 class AudioParameterError(AudioIOError):
     """Raised when one audio parameter is missing when loading raw data or
     saving data to a format other than raw. Also raised when an audio
-    parameter has a wrong value"""
+    parameter has a wrong value."""
 
 
 class AudioEncodingError(Exception):