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

added docs for spaces in scale names

Browse source
This commit is contained in:
Ondřej Žára 2025-11-03 22:03:39 +01:00
parent 92e3a80e65
commit 4df2cc3086
No known key found for this signature in database
GPG key ID: B0A5751E616840C5
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
packages/tonal/tonal.mjs
View file

@ -229,6 +229,9 @@ function _getNearestScaleNote(scaleName, note, preferHigher = true) {
*
* A scale consists of a root note (e.g. `c4`, `c`, `f#`, `bb4`) followed by semicolon (':') and then a [scale type](https://github.com/tonaljs/tonal/blob/main/packages/scale-type/data.ts).
*
* The scale name must be written without spaces (because it would be interpreted as a multi-step pattern otherwise).
* If your scale name includes spaces, replace them with colons.
*
* The root note defaults to octave 3, if no octave number is given.
*
* @name scale
@ -250,6 +253,8 @@ function _getNearestScaleNote(scaleName, note, preferHigher = true) {
* .s("piano")
* @example
* note("C1*16").transpose(irand(36)).scale('Cb2 major').scaleTranspose(3)
* @example
* n("[0 0] [1 2] [3 4] [5 6]").scale("C:major:blues")
*/
export const scale = register(
'scale',