Merge pull request #982 from daslyfe/fix_distort_doc

replace shape with distort in learn doc
tidalcycles · Mar 8, 2024 · 0875e80 · 0875e80
2 parents 8e41332 + f1700d5
commit 0875e80
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/packages/superdough/README.md b/packages/superdough/README.md
@@ -65,7 +65,7 @@ superdough({ s: 'bd', delay: 0.5 }, 0, 1);
   - `bandf`: band pass filter cutoff
   - `bandq`: band pass  filter resonance
   - `crush`: amplitude bit crusher using given number of bits
-  - `shape`: distortion effect from 0 (none) to 1 (full). might get loud!
+  - `distort`: distortion effect. might get loud!
   - `pan`: stereo panning from 0 (left) to 1 (right)
   - `phaser`: sets the speed of the modulation
   - `phaserdepth`: the amount the signal is affected by the phaser effect.

diff --git a/website/src/pages/learn/effects.mdx b/website/src/pages/learn/effects.mdx
@@ -238,9 +238,9 @@ Let's break down all pitch envelope controls:
 
 <JsDoc client:idle name="crush" h={0} />
 
-## shape
+## distort
 
-<JsDoc client:idle name="shape" h={0} />
+<JsDoc client:idle name="distort" h={0} />
 
 # Global Effects