From 72298c5f037f43470d9be6929b1a099a2b3b4228 Mon Sep 17 00:00:00 2001
From: Aria <weglossing@gmail.com>
Date: Wed, 1 Oct 2025 00:45:26 -0500
Subject: [PATCH] Docstring cleanup

---
 packages/core/controls.mjs |  8 +++++---
 packages/core/pattern.mjs  | 25 ++++++++++++++++---------
 2 files changed, 21 insertions(+), 12 deletions(-)

diff --git a/packages/core/controls.mjs b/packages/core/controls.mjs
index 5148e47e7..3475fc2f4 100644
--- a/packages/core/controls.mjs
+++ b/packages/core/controls.mjs
@@ -1892,7 +1892,9 @@ export const { shape } = registerControl(['shape', 'shapevol']);
  *
  * @name distort
  * @synonyms dist
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
+ * @param {number | string | Pattern} type type of distortion to apply
  * @example
  * s("bd sd [~ bd] sd,hh*8").distort("<0 2 3 10:.5>")
  * @example
@@ -1908,7 +1910,7 @@ export const { distort, dist } = registerControl(['distort', 'distortvol', 'dist
  *
  * @name distortvol
  * @synonyms distvol
- * @param {number | Pattern} type
+ * @param {number | Pattern} volume linear postgain of the distortion
  * @example
  * s("bd*4").bank("tr909").distort(2).distortvol(0.8)
  */
@@ -1919,7 +1921,7 @@ export const { distortvol } = registerControl('distortvol', 'distvol');
  *
  * @name distorttype
  * @synonyms disttype
- * @param {number | string | Pattern} type
+ * @param {number | string | Pattern} type type of distortion to apply
  * @example
  * s("bd*4").bank("tr909").distort(2).distorttype("<0 1 2>")
  *
diff --git a/packages/core/pattern.mjs b/packages/core/pattern.mjs
index e2e563e4f..a823e7bca 100644
--- a/packages/core/pattern.mjs
+++ b/packages/core/pattern.mjs
@@ -3541,59 +3541,66 @@ export const morph = (frompat, topat, bypat) => {
  * Soft-clipping distortion
  *
  * @name soft
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Hard-clipping distortion
  *
  * @name hard
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Cubic polynomial distortion
  *
  * @name cubic
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Diode-emulating distortion
  *
  * @name diode
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Asymmetrical diode distortion
  *
  * @name asym
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Wavefolding distortion
  *
  * @name fold
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Wavefolding distortion composed with sinusoid
  *
  * @name sinefold
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
 /**
  * Distortion via Chebyshev polynomials
  *
  * @name chebyshev
- * @param {number | Pattern} distortion
+ * @param {number | Pattern} distortion amount of distortion to apply
+ * @param {number | Pattern} volume linear postgain of the distortion
  *
  */
-
 const distAlgoNames = ['scurve', 'soft', 'hard', 'cubic', 'diode', 'asym', 'fold', 'sinefold', 'chebyshev'];
 for (const name of distAlgoNames) {
   // Add aliases for distortion algorithms