From ad84b37349fdca26c3385038bfd0bc750322deef Mon Sep 17 00:00:00 2001 From: iver56 Date: Wed, 6 Mar 2024 10:34:48 +0100 Subject: [PATCH] Tweak wording in AddColorNoise docs --- audiomentations/augmentations/add_color_noise.py | 2 +- docs/waveform_transforms/add_color_noise.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/audiomentations/augmentations/add_color_noise.py b/audiomentations/augmentations/add_color_noise.py index 6a2db8e9..529b0bfc 100644 --- a/audiomentations/augmentations/add_color_noise.py +++ b/audiomentations/augmentations/add_color_noise.py @@ -115,7 +115,7 @@ def generate_decaying_white_noise( class AddColorNoise(BaseWaveformTransform): """ Adds noise to the input samples with a decaying frequency spectrum resulting in "color" noise. - For more see the Wikipedia article here: https://en.wikipedia.org/wiki/Colors_of_noise + For info, more see the Wikipedia article here: https://en.wikipedia.org/wiki/Colors_of_noise """ supports_multichannel = True diff --git a/docs/waveform_transforms/add_color_noise.md b/docs/waveform_transforms/add_color_noise.md index 25df9f29..e1baabd3 100644 --- a/docs/waveform_transforms/add_color_noise.md +++ b/docs/waveform_transforms/add_color_noise.md @@ -2,9 +2,8 @@ _To be added in v0.35.0_ -Mix in noise with color, additionally weighted by an [A-weighting :octicons-link-external-16:](https://en.wikipedia.org/wiki/A-weighting){target=_blank} curve. When -`f_decay=0` this is equivalent to `AddGaussianNoise`, with an option for weighting it -with an `A-weighting` curve. Otherwise, see: [Colors of Noise :octicons-link-external-16:](https://en.wikipedia.org/wiki/Colors_of_noise){target=_blank}. +Mix in noise with color, optionally weighted by an [A-weighting :octicons-link-external-16:](https://en.wikipedia.org/wiki/A-weighting){target=_blank} curve. When +`f_decay=0`, this is equivalent to `AddGaussianNoise`. Otherwise, see: [Colors of Noise :octicons-link-external-16:](https://en.wikipedia.org/wiki/Colors_of_noise){target=_blank}. ## AddColorNoise API