Merge pull request #355 from iver56/ij/docs

Fix and improve grammar in docs

docs/changelog.md

@@ -206,7 +206,7 @@ These are **breaking changes**. The following example shows how you can adapt yo
 
 ### Fixed
 
-* Fix filter instability bug related to center freq above nyquist freq in `LowShelfFilter` and `HighShelfFilter`
+* Fix filter instability bug related to center freq above Nyquist freq in `LowShelfFilter` and `HighShelfFilter`
 
 ## [0.23.0] - 2022-03-07
 

docs/waveform_transforms/add_gaussian_snr.md

@@ -53,14 +53,14 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=16000)
 :   :octicons-milestone-24: Default: `5.0`. Minimum signal-to-noise ratio in dB. A lower
     number means more noise.
 
-[`max_snr_db`](#max_snr_db){ #max_snr_db }: `float` • unit: decibel
+[`max_snr_db`](#max_snr_db){ #max_snr_db }: `float` • unit: Decibel
 :   :octicons-milestone-24: Default: `40.0`. Maximum signal-to-noise ratio in dB. A
     greater number means less noise.
 
 ~~[`min_snr_in_db`](#min_snr_in_db){ #min_snr_in_db }: `float` • unit: Decibel~~
 :   :warning: Deprecated as of v0.31.0, removed as of v0.38.0. Use [`min_snr_db`](#min_snr_db) instead
 
-~~[`max_snr_in_db`](#max_snr_in_db){ #max_snr_in_db }: `float` • unit: decibel~~
+~~[`max_snr_in_db`](#max_snr_in_db){ #max_snr_in_db }: `float` • unit: Decibel~~
 :   :warning: Deprecated as of v0.31.0, removed as of v0.38.0. Use [`max_snr_db`](#max_snr_db) instead
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]

docs/waveform_transforms/adjust_duration.md

@@ -56,6 +56,9 @@ Here we input an audio clip and remove a part of the start and the end, so the l
 
 [`padding_mode`](#padding_mode){ #padding_mode }: `str` • choices: `"silence"`, `"wrap"`, `"reflect"`
 :   :octicons-milestone-24: Default: `"silence"`. Padding mode. Only used when audio input is shorter than the target duration.
+    * `"silence"`: Pads with zeros (silence).
+    * `"wrap"`: Pads by wrapping the existing audio content.
+    * `"reflect"`: Pads by reflecting the audio at the boundaries.
 
 [`padding_position`](#padding_position){ #padding_position }: `str` • choices: `"start"`, `"end"`
 :   :octicons-milestone-24: Default: `"end"`. The position of the inserted/added padding. Only used when audio input is shorter than the target duration.

docs/waveform_transforms/aliasing.md

@@ -4,13 +4,13 @@ _Added in v0.35.0_
 
 Downsample the audio to a lower sample rate by linear interpolation, without low-pass
 filtering it first, resulting in aliasing artifacts. You get aliasing artifacts when
-there is high-frequency audio in the input audio that falls above the nyquist frequency
-of the chosen target sample rate. Audio with frequencies above the nyquist frequency
-cannot be reproduced accurately and get "reflected"/mirrored to other frequencies. The
-aliasing artifacts "replace" the original high frequency signals. The result can be
+there is high-frequency audio in the input audio that falls above the Nyquist frequency
+of the chosen target sample rate. Audio with frequencies above the Nyquist frequency
+cannot be reproduced accurately and gets "reflected"/mirrored to other frequencies. The
+aliasing artifacts replace the original high-frequency signals. The result can be
 described as coarse and metallic.
 
-After the downsampling, the signal gets upsampled to the original signal again, so the
+After the downsampling, the signal gets upsampled to the original sample rate again, so the
 length of the output becomes the same as the length of the input.
 
 For more information, see

docs/waveform_transforms/high_shelf_filter.md

@@ -5,7 +5,7 @@ _Added in v0.21.0_
 A high shelf filter is a filter that either boosts (increases amplitude) or cuts
 (decreases amplitude) frequencies above a certain center frequency. This transform
 applies a high-shelf filter at a specific center frequency in hertz.
-The gain at nyquist frequency is controlled by `{min,max}_gain_db` (note: can be positive or negative!).
+The gain at Nyquist frequency is controlled by `{min,max}_gain_db` (note: can be positive or negative!).
 Filter coefficients are taken from [the W3 Audio EQ Cookbook :octicons-link-external-16:](https://www.w3.org/TR/audio-eq-cookbook/)
 
 # HighShelfFilter API
@@ -17,10 +17,10 @@ Filter coefficients are taken from [the W3 Audio EQ Cookbook :octicons-link-exte
 :   :octicons-milestone-24: Default: `7500.0`. The maximum center frequency of the shelving filter
 
 [`min_gain_db`](#min_gain_db){ #min_gain_db }: `float` • unit: Decibel
-:   :octicons-milestone-24: Default: `-18.0`. The minimum gain at the nyquist frequency
+:   :octicons-milestone-24: Default: `-18.0`. The minimum gain at the Nyquist frequency
 
 [`max_gain_db`](#max_gain_db){ #max_gain_db }: `float` • unit: Decibel
-:   :octicons-milestone-24: Default: `18.0`. The maximum gain at the nyquist frequency
+:   :octicons-milestone-24: Default: `18.0`. The maximum gain at the Nyquist frequency
 
 [`min_q`](#min_q){ #min_q }: `float` • range: (0.0, 1.0]
 :   :octicons-milestone-24: Default: `0.1`. The minimum quality factor Q. The higher

docs/waveform_transforms/seven_band_parametric_eq.md

@@ -33,7 +33,7 @@ The seven bands have center frequencies picked in the following ranges (min-max)
 [`min_gain_db`](#min_gain_db){ #min_gain_db }: `float` • unit: Decibel
 :   :octicons-milestone-24: Default: `-12.0`. Minimum number of dB to cut or boost a band
 
-[`max_gain_db`](#max_gain_db){ #max_gain_db }: `float` • unit: decibel
+[`max_gain_db`](#max_gain_db){ #max_gain_db }: `float` • unit: Decibel
 :   :octicons-milestone-24: Default: `12.0`. Maximum number of dB to cut or boost a band
 
 [`p`](#p){ #p }: `float` • range: [0.0, 1.0]