hacklab/strudel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docstring cleanup

Browse source
This commit is contained in:
Aria 2025-10-01 00:45:26 -05:00
parent c885d84785
commit 72298c5f03
2 changed files with 21 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
packages/core/controls.mjs
View file

@ -1892,7 +1892,9 @@ export const { shape } = registerControl(['shape', 'shapevol']);
* *
* @name distort * @name distort
* @synonyms dist * @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 * @example
* s("bd sd [~ bd] sd,hh*8").distort("<0 2 3 10:.5>") * s("bd sd [~ bd] sd,hh*8").distort("<0 2 3 10:.5>")
* @example * @example
@ -1908,7 +1910,7 @@ export const { distort, dist } = registerControl(['distort', 'distortvol', 'dist
* *
* @name distortvol * @name distortvol
* @synonyms distvol * @synonyms distvol
* @param {number | Pattern} type * @param {number | Pattern} volume linear postgain of the distortion
* @example * @example
* s("bd*4").bank("tr909").distort(2).distortvol(0.8) * s("bd*4").bank("tr909").distort(2).distortvol(0.8)
*/ */
@ -1919,7 +1921,7 @@ export const { distortvol } = registerControl('distortvol', 'distvol');
* *
* @name distorttype * @name distorttype
* @synonyms disttype * @synonyms disttype
* @param {number | string | Pattern} type * @param {number | string | Pattern} type type of distortion to apply
* @example * @example
* s("bd*4").bank("tr909").distort(2).distorttype("<0 1 2>") * s("bd*4").bank("tr909").distort(2).distorttype("<0 1 2>")
* *

25
packages/core/pattern.mjs
View file

@ -3541,59 +3541,66 @@ export const morph = (frompat, topat, bypat) => {
* Soft-clipping distortion * Soft-clipping distortion
* *
* @name soft * @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 * Hard-clipping distortion
* *
* @name hard * @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 * Cubic polynomial distortion
* *
* @name cubic * @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 * Diode-emulating distortion
* *
* @name diode * @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 * Asymmetrical diode distortion
* *
* @name asym * @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 * Wavefolding distortion
* *
* @name fold * @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 * Wavefolding distortion composed with sinusoid
* *
* @name sinefold * @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 * Distortion via Chebyshev polynomials
* *
* @name chebyshev * @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']; const distAlgoNames = ['scurve', 'soft', 'hard', 'cubic', 'diode', 'asym', 'fold', 'sinefold', 'chebyshev'];
for (const name of distAlgoNames) { for (const name of distAlgoNames) {
// Add aliases for distortion algorithms // Add aliases for distortion algorithms