major update of docstrings

Author: fzalkow

libfmp/b/b_annotation.py

@@ -17,12 +17,12 @@ def read_csv(fn, header=True, add_label=False):
     """Reads a CSV file
 
     Args:
-        fn: Filename
-        header: Boolean
-        add_label: Add column with constant value of `add_label`
+        fn (str): Filename
+        header (bool): Boolean (Default value = True)
+        add_label (bool): Add column with constant value of `add_label` (Default value = False)
 
     Returns:
-        df: Pandas DataFrame
+        df (pd.DataFrame): Pandas DataFrame
     """
     df = pd.read_csv(fn, sep=';', keep_default_na=False, header=0 if header else None)
     if add_label:
@@ -35,29 +35,27 @@ def write_csv(df, fn, header=True):
     """Writes a CSV file
 
     Args:
-        df: Pandas DataFrame
-        fn: Filename
-        header: Boolean
+        df (pd.DataFrame): Pandas DataFrame
+        fn (str): Filename
+        header (bool): Boolean (Default value = True)
     """
     df.to_csv(fn, sep=';', index=False, quoting=2, header=header)
 
 
 def cut_audio(fn_in, fn_out, start_sec, end_sec, normalize=True, write=True, Fs=22050):
     """Cuts an audio file
 
-    Notebook: B/B_Annotations_cut.ipynb
-
     Args:
-        fn_in: Filename and path for input audio file
-        fn_out: Filename and path for input audio file
-        start_sec: Start time position (in seconds) of cut
-        end_sec: End time position (in seconds) of cut
-        normalize: If True, then normalize audio (with max norm)
-        write: If True, then write audio
-        Fs: Sampling rate of audio
+        fn_in (str): Filename and path for input audio file
+        fn_out (str): Filename and path for input audio file
+        start_sec (float): Start time position (in seconds) of cut
+        end_sec (float): End time position (in seconds) of cut
+        normalize (bool): If True, then normalize audio (with max norm) (Default value = True)
+        write (bool): If True, then write audio (Default value = True)
+        Fs (scalar): Sampling rate of audio (Default value = 22050)
 
     Returns:
-        x_cut: Cut audio
+        x_cut (np.ndarray): Cut audio
     """
     x_cut, Fs = librosa.load(fn_in, sr=Fs, offset=start_sec, duration=end_sec-start_sec)
     if normalize is True:
@@ -70,17 +68,15 @@ def cut_audio(fn_in, fn_out, start_sec, end_sec, normalize=True, write=True, Fs=
 def cut_csv_file(fn_in, fn_out, start_sec, end_sec, write=True):
     """Cuts csv annotation file
 
-    Notebook: B/B_Annotations_cut.ipynb
-
     Args:
-        fn_in: Filename and path for input audio file
-        fn_out: Filename and path for input audio file
-        start_sec: Start time position (in seconds) of cut
-        end_sec: End time position (in seconds) of cut
-        write: If True, then write audio
+        fn_in (str): Filename and path for input audio file
+        fn_out (str): Filename and path for input audio file
+        start_sec (float): Start time position (in seconds) of cut
+        end_sec (float): End time position (in seconds) of cut
+        write (bool): If True, then write audio (Default value = True)
 
     Returns:
-        ann_cut: Cut annotation file
+        ann_cut (list): Cut annotation file
     """
     df = pd.read_csv(fn_in, sep=',', keep_default_na=False, header=None)
     ann_cut = []

libfmp/b/b_audio.py

@@ -16,13 +16,13 @@ def read_audio(path, Fs=None, mono=False):
     """Reads an audio file
 
     Args:
-        path: Path to audio file
-        Fs: Resample audio to given sampling rate. Use native sampling rate if None.
-        mono (bool): Convert multi-channel file to mono.
+        path (str): Path to audio file
+        Fs (scalar): Resample audio to given sampling rate. Use native sampling rate if None. (Default value = None)
+        mono (bool): Convert multi-channel file to mono. (Default value = False)
 
     Returns:
-        x: Waveform signal
-        Fs: Sampling rate
+        x (np.ndarray): Waveform signal
+        Fs (scalar): Sampling rate
     """
     return librosa.load(path, sr=Fs, mono=mono)
 
@@ -31,25 +31,25 @@ def write_audio(path, x, Fs):
     """Writes an audio file
 
     Args:
-        path: Path to audio file
-        x: Waveform signal
-        Fs: Sampling rate
+        path (str): Path to audio file
+        x (np.ndarray): Waveform signal
+        Fs (scalar): Sampling rate
     """
     sf.write(path, x, Fs)
 
 
 def audio_player_list(signals, rates, width=270, height=40, columns=None, column_align='center'):
-    """Generate list of audio players
+    """Generates list of audio players
 
     Notebook: B/B_PythonAudio.ipynb
 
     Args:
-        signals: List of audio signals
-        rates: List of sample rates
-        width: Width of player (either number or list)
-        height: Height of player (either number or list)
-        columns: Column headings
-        column_align: Left, center, right
+        signals (list): List of audio signals
+        rates (list): List of sample rates
+        width (int): Width of player (either number or list) (Default value = 270)
+        height (int): Height of player (either number or list) (Default value = 40)
+        columns (list): Column headings (Default value = None)
+        column_align (str): Left, center, right (Default value = 'center')
     """
     pd.set_option('display.max_colwidth', None)
 

libfmp/b/b_layout.py

@@ -13,8 +13,8 @@
 
 
 class FloatingBox(object):
-    """
-    Inspired by https://stackoverflow.com/a/49566213/2812618
+    """Inspired by https://stackoverflow.com/a/49566213/2812618
+
     Floating box for matplotlib plots. The added figures are part of a floating box.
 
     Attributes:
@@ -57,13 +57,17 @@ def add_fig(self, fig):
         plt.close(fig)
 
     def add_html(self, html):
+        """Add HTML to floating box
+
+        Args:
+            html: HTML string
+        """
 
         self.html += (
             f'<div class="{self.class_name}">' +
             f'{html}' +
             '</div>')
 
     def show(self):
-        """Display the accumulated HTML
-        """
+        """Display the accumulated HTML"""
         display(HTML(self.html))