Merge pull request #352 from iver56/ij/docs

Fix AddShortNoises documentation errors

audiomentations/augmentations/add_short_noises.py

@@ -94,7 +94,7 @@ def __init__(
             fraction) the burst sound should start playing. The value must be greater than 0.
         :param min_fade_in_time: Min sound/noise fade in time in seconds. Use a value larger
             than 0 to avoid a "click" at the start of the sound/noise.
-        :param max_fade_in_time: Max sound/noise fade out time in seconds. Use a value larger
+        :param max_fade_in_time: Max sound/noise fade in time in seconds. Use a value larger
             than 0 to avoid a "click" at the start of the sound/noise.
         :param min_fade_out_time: Min sound/noise fade out time in seconds. Use a value larger
             than 0 to avoid a "click" at the end of the sound/noise.

docs/waveform_transforms/add_short_noises.md

@@ -92,8 +92,7 @@ Here we add some short noise sounds to a voice recording.
     added sounds/noises
 
 [`noise_rms`](#noise_rms){ #noise_rms }: `str` • choices: `"absolute"`, `"relative"`, `"relative_to_whole_input"`
-:   :octicons-milestone-24: Default: `"relative"` (<=v0.27), but will be changed to
-    `"relative_to_whole_input"` in a future version.
+:   :octicons-milestone-24: Default: `"relative_to_whole_input"` (since v0.29.0)
 
     This parameter defines how the noises will be added to the audio input.
 
@@ -109,7 +108,7 @@ Here we add some short noise sounds to a voice recording.
     `"absolute"`. It is the minimum RMS value in dB that the added noise can take. The
     lower the RMS is, the lower will the added sound be.
 
-[`max_absolute_noise_rms_db`](#max_absolute_noise_rms_db){ #max_absolute_noise_rms_db }: `float` • unit: seconds
+[`max_absolute_noise_rms_db`](#max_absolute_noise_rms_db){ #max_absolute_noise_rms_db }: `float` • unit: Decibel
 :   :octicons-milestone-24: Default: `-20.0`. Is only used if `noise_rms` is set to
     `"absolute"`. It is the maximum RMS value in dB that the added noise can take. Note
     that this value can not exceed 0.