Added some description and examples of multi-accidentals and negative octaves

packages/core/controls.mjs

@@ -113,7 +113,7 @@ export const { n } = registerControl('n');
  *
  * - a letter (a-g or A-G)
  * - optional accidentals (b or #)
- * - optional octave number (0-9). Defaults to 3
+ * - optional (possibly negative) octave number (0-9). Defaults to 3
  *
  * Examples of valid note names: `c`, `bb`, `Bb`, `f#`, `c3`, `A4`, `Eb2`, `c#5`
  *
@@ -126,6 +126,8 @@ export const { n } = registerControl('n');
  * note("c4 a4 f4 e4")
  * @example
  * note("60 69 65 64")
+ * @example
+ * note("fbb1 a#0 cbbb-1 e##-2").sound("saw")
  */
 export const { note } = registerControl(['note', 'n']);
 

packages/tonal/tonal.mjs

@@ -252,6 +252,8 @@ function _getNearestScaleNote(scaleName, note, preferHigher = true) {
  * n("<[0,7b] [-4# -4] [-2,7##] 4 [0,7] [-4# -4b] [-2,7###] 4b>*4")
  * .scale("C:<major minor>/2")
  * .s("piano")
+ * @example
+ * note("C1*16").transpose(irand(36)).scale('Cb2 major').scaleTranspose(3)
  */
 
 export const scale = register(

test/__snapshots__/examples.test.mjs.snap

@@ -6436,6 +6436,27 @@ exports[`runs examples > example "note" example index 2 1`] = `
 ]
 `;
 
+exports[`runs examples > example "note" example index 3 1`] = `
+[
+  "[ 0/1 → 1/4 | note:fbb1 s:saw ]",
+  "[ 1/4 → 1/2 | note:a#0 s:saw ]",
+  "[ 1/2 → 3/4 | note:cbbb-1 s:saw ]",
+  "[ 3/4 → 1/1 | note:e##-2 s:saw ]",
+  "[ 1/1 → 5/4 | note:fbb1 s:saw ]",
+  "[ 5/4 → 3/2 | note:a#0 s:saw ]",
+  "[ 3/2 → 7/4 | note:cbbb-1 s:saw ]",
+  "[ 7/4 → 2/1 | note:e##-2 s:saw ]",
+  "[ 2/1 → 9/4 | note:fbb1 s:saw ]",
+  "[ 9/4 → 5/2 | note:a#0 s:saw ]",
+  "[ 5/2 → 11/4 | note:cbbb-1 s:saw ]",
+  "[ 11/4 → 3/1 | note:e##-2 s:saw ]",
+  "[ 3/1 → 13/4 | note:fbb1 s:saw ]",
+  "[ 13/4 → 7/2 | note:a#0 s:saw ]",
+  "[ 7/2 → 15/4 | note:cbbb-1 s:saw ]",
+  "[ 15/4 → 4/1 | note:e##-2 s:saw ]",
+]
+`;
+
 exports[`runs examples > example "nrpnn" example index 0 1`] = `
 [
   "[ 0/1 → 1/1 | note:c4 nrpnn:[1 8] nrpv:123 midichan:1 ]",
@@ -8699,6 +8720,75 @@ exports[`runs examples > example "scale" example index 3 1`] = `
 ]
 `;
 
+exports[`runs examples > example "scale" example index 4 1`] = `
+[
+  "[ 0/1 → 1/16 | note:Gb1 ]",
+  "[ 1/16 → 1/8 | note:Gb1 ]",
+  "[ 1/8 → 3/16 | note:Gb1 ]",
+  "[ 3/16 → 1/4 | note:Gb1 ]",
+  "[ 1/4 → 5/16 | note:Gb1 ]",
+  "[ 5/16 → 3/8 | note:Gb1 ]",
+  "[ 3/8 → 7/16 | note:Gb1 ]",
+  "[ 7/16 → 1/2 | note:Gb1 ]",
+  "[ 1/2 → 9/16 | note:Gb1 ]",
+  "[ 9/16 → 5/8 | note:Gb1 ]",
+  "[ 5/8 → 11/16 | note:Gb1 ]",
+  "[ 11/16 → 3/4 | note:Gb1 ]",
+  "[ 3/4 → 13/16 | note:Gb1 ]",
+  "[ 13/16 → 7/8 | note:Gb1 ]",
+  "[ 7/8 → 15/16 | note:Gb1 ]",
+  "[ 15/16 → 1/1 | note:Gb1 ]",
+  "[ 1/1 → 17/16 | note:Cb3 ]",
+  "[ 17/16 → 9/8 | note:Cb3 ]",
+  "[ 9/8 → 19/16 | note:Cb3 ]",
+  "[ 19/16 → 5/4 | note:Cb3 ]",
+  "[ 5/4 → 21/16 | note:Cb3 ]",
+  "[ 21/16 → 11/8 | note:Cb3 ]",
+  "[ 11/8 → 23/16 | note:Cb3 ]",
+  "[ 23/16 → 3/2 | note:Cb3 ]",
+  "[ 3/2 → 25/16 | note:Cb3 ]",
+  "[ 25/16 → 13/8 | note:Cb3 ]",
+  "[ 13/8 → 27/16 | note:Cb3 ]",
+  "[ 27/16 → 7/4 | note:Cb3 ]",
+  "[ 7/4 → 29/16 | note:Cb3 ]",
+  "[ 29/16 → 15/8 | note:Cb3 ]",
+  "[ 15/8 → 31/16 | note:Cb3 ]",
+  "[ 31/16 → 2/1 | note:Cb3 ]",
+  "[ 2/1 → 33/16 | note:Eb4 ]",
+  "[ 33/16 → 17/8 | note:Eb4 ]",
+  "[ 17/8 → 35/16 | note:Eb4 ]",
+  "[ 35/16 → 9/4 | note:Eb4 ]",
+  "[ 9/4 → 37/16 | note:Eb4 ]",
+  "[ 37/16 → 19/8 | note:Eb4 ]",
+  "[ 19/8 → 39/16 | note:Eb4 ]",
+  "[ 39/16 → 5/2 | note:Eb4 ]",
+  "[ 5/2 → 41/16 | note:Eb4 ]",
+  "[ 41/16 → 21/8 | note:Eb4 ]",
+  "[ 21/8 → 43/16 | note:Eb4 ]",
+  "[ 43/16 → 11/4 | note:Eb4 ]",
+  "[ 11/4 → 45/16 | note:Eb4 ]",
+  "[ 45/16 → 23/8 | note:Eb4 ]",
+  "[ 23/8 → 47/16 | note:Eb4 ]",
+  "[ 47/16 → 3/1 | note:Eb4 ]",
+  "[ 3/1 → 49/16 | note:Db2 ]",
+  "[ 49/16 → 25/8 | note:Db2 ]",
+  "[ 25/8 → 51/16 | note:Db2 ]",
+  "[ 51/16 → 13/4 | note:Db2 ]",
+  "[ 13/4 → 53/16 | note:Db2 ]",
+  "[ 53/16 → 27/8 | note:Db2 ]",
+  "[ 27/8 → 55/16 | note:Db2 ]",
+  "[ 55/16 → 7/2 | note:Db2 ]",
+  "[ 7/2 → 57/16 | note:Db2 ]",
+  "[ 57/16 → 29/8 | note:Db2 ]",
+  "[ 29/8 → 59/16 | note:Db2 ]",
+  "[ 59/16 → 15/4 | note:Db2 ]",
+  "[ 15/4 → 61/16 | note:Db2 ]",
+  "[ 61/16 → 31/8 | note:Db2 ]",
+  "[ 31/8 → 63/16 | note:Db2 ]",
+  "[ 63/16 → 4/1 | note:Db2 ]",
+]
+`;
+
 exports[`runs examples > example "scaleTranspose" example index 0 1`] = `
 [
   "[ 0/1 → 1/2 | note:C3 ]",