fix: typo on docs causing problems with autocompletion. (#1350)

* fix: scramble and shuffle comments

* fix: comments on themes,docs, tests and more

packages/codemirror/themes/CutiePi.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name Cutie Pi
+ * Cutie Pi
  * by Switch Angel
  */
 import { tags as t } from '@lezer/highlight';

packages/codemirror/themes/androidstudio.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name androidstudio
+ * androidstudio
  */
 import { tags as t } from '@lezer/highlight';
 import { createTheme } from './theme-helper.mjs';

packages/codemirror/themes/atomone.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name Atom One
+ * Atom One
  * Atom One dark syntax theme
  *
  * https://github.com/atom/one-dark-syntax

packages/codemirror/themes/darcula.mjs

@@ -1,6 +1,5 @@
-/**
+/*
- * @name darcula
+ * darcula
- * @author darcula
  * Name: IntelliJ IDEA darcula theme
  * From IntelliJ IDEA by JetBrains
  */

packages/codemirror/themes/dracula.mjs

@@ -1,6 +1,5 @@
-/**
+/*
  * @name dracula
- * @author dracula
  * Michael Kaminsky (http://github.com/mkaminsky11)
  * Original dracula color scheme by Zeno Rocha (https://github.com/zenorocha/dracula-theme)
  */

packages/codemirror/themes/duotoneDark.mjs

@@ -1,6 +1,6 @@
-/**
+/*
- * @name duotone
+ * duotone
- * @author Bram de Haan
+ * author Bram de Haan
  * by Bram de Haan, adapted from DuoTone themes by Simurai (http://simurai.com/projects/2016/01/01/duotone-themes)
  */
 import { tags as t } from '@lezer/highlight';

packages/codemirror/themes/duotoneLight.mjs

@@ -1,6 +1,6 @@
-/**
+/*
- * @name duotone
+ * duotone
- * @author Bram de Haan
+ * author Bram de Haan
  * by Bram de Haan, adapted from DuoTone themes by Simurai (http://simurai.com/projects/2016/01/01/duotone-themes)
  */
 import { tags as t } from '@lezer/highlight';

packages/codemirror/themes/githubDark.mjs

@@ -1,6 +1,3 @@
-/**
- * @name github
- */
 import { tags as t } from '@lezer/highlight';
 import { createTheme } from './theme-helper.mjs';
 

packages/codemirror/themes/githubLight.mjs

@@ -1,6 +1,3 @@
-/**
- * @name github
- */
 import { tags as t } from '@lezer/highlight';
 import { createTheme } from './theme-helper.mjs';
 

packages/codemirror/themes/green-text.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name Atom One
+ * Atom One
  * Atom One dark syntax theme
  *
  * https://github.com/atom/one-dark-syntax

packages/codemirror/themes/gruvboxDark.mjs

@@ -1,7 +1,6 @@
-/**
+/*
- * @name gruvbox-dark
+ * gruvbox-dark
- * @author morhetz
+ * author morhetz
- * Name: Gruvbox
  * From github.com/codemirror/codemirror5/blob/master/theme/gruvbox-dark.css
  */
 import { tags as t } from '@lezer/highlight';

packages/codemirror/themes/gruvboxLight.mjs

@@ -1,7 +1,6 @@
-/**
+/*
- * @name gruvbox-light
+ * gruvbox-light
- * @author morhetz
+ * author morhetz
- * Name: Gruvbox
  * From github.com/codemirror/codemirror5/blob/master/theme/gruvbox-light.css
  */
 import { tags as t } from '@lezer/highlight';

packages/codemirror/themes/red-text.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name Atom One
+ * Atom One
  * Atom One dark syntax theme
  *
  * https://github.com/atom/one-dark-syntax

packages/codemirror/themes/sonic-pink.mjs

@@ -1,5 +1,5 @@
-/**
+/*
- * @name Atom One
+ * Atom One
  * Atom One dark syntax theme
  *
  * https://github.com/atom/one-dark-syntax

packages/core/controls.mjs

@@ -1496,7 +1496,7 @@ export const { vowel } = registerControl('vowel');
  * @name waveloss
  */
 export const { waveloss } = registerControl('waveloss');
-/*
+/**
  * Noise crackle density
  *
  * @name density

packages/core/pick.mjs

@@ -156,8 +156,7 @@ export const pickmodReset = register('pickmodReset', function (lookup, pat) {
   return _pick(lookup, pat, true).resetJoin();
 });
 
-/**
+/** Picks patterns (or plain values) either from a list (by index) or a lookup table (by name).
-  /** * Picks patterns (or plain values) either from a list (by index) or a lookup table (by name).
    * Similar to `pick`, but cycles are squeezed into the target ('inhabited') pattern.
    * @name inhabit
    * @synonyms pickSqueeze

packages/core/signal.mjs

@@ -279,9 +279,9 @@ const _rearrangeWith = (ipat, n, pat) => {
 };
 
 /**
- * @name shuffle
  * Slices a pattern into the given number of parts, then plays those parts in random order.
  * Each part will be played exactly once per cycle.
+ * @name shuffle
  * @example
  * note("c d e f").sound("piano").shuffle(4)
  * @example
@@ -292,9 +292,9 @@ export const shuffle = register('shuffle', (n, pat) => {
 });
 
 /**
- * @name scramble
  * Slices a pattern into the given number of parts, then plays those parts at random. Similar to `shuffle`,
  * but parts might be played more than once, or not at all, per cycle.
+ * @name scramble
  * @example
  * note("c d e f").sound("piano").scramble(4)
  * @example

test/__snapshots__/examples.test.mjs.snap

@@ -2403,6 +2403,27 @@ exports[`runs examples > example "delaytime" example index 0 1`] = `
 ]
 `;
 
+exports[`runs examples > example "density" example index 0 1`] = `
+[
+  "[ 0/1 → 1/4 | s:crackle density:0.01 ]",
+  "[ 1/4 → 1/2 | s:crackle density:0.01 ]",
+  "[ 1/2 → 3/4 | s:crackle density:0.01 ]",
+  "[ 3/4 → 1/1 | s:crackle density:0.01 ]",
+  "[ 1/1 → 5/4 | s:crackle density:0.01 ]",
+  "[ 5/4 → 3/2 | s:crackle density:0.01 ]",
+  "[ 3/2 → 7/4 | s:crackle density:0.01 ]",
+  "[ 7/4 → 2/1 | s:crackle density:0.01 ]",
+  "[ 2/1 → 9/4 | s:crackle density:0.01 ]",
+  "[ 9/4 → 5/2 | s:crackle density:0.01 ]",
+  "[ 5/2 → 11/4 | s:crackle density:0.01 ]",
+  "[ 11/4 → 3/1 | s:crackle density:0.01 ]",
+  "[ 3/1 → 13/4 | s:crackle density:0.01 ]",
+  "[ 13/4 → 7/2 | s:crackle density:0.01 ]",
+  "[ 7/2 → 15/4 | s:crackle density:0.01 ]",
+  "[ 15/4 → 4/1 | s:crackle density:0.01 ]",
+]
+`;
+
 exports[`runs examples > example "detune" example index 0 1`] = `
 [
   "[ 0/1 → 1/12 | note:d s:supersaw detune:0.1 ]",
@@ -8051,6 +8072,52 @@ but parts might be played more than once, or not at all, per cycle." example ind
 ]
 `;
 
+exports[`runs examples > example "scramble" example index 0 1`] = `
+[
+  "[ 0/1 → 1/4 | note:c s:piano ]",
+  "[ 1/4 → 1/2 | note:d s:piano ]",
+  "[ 1/2 → 3/4 | note:d s:piano ]",
+  "[ 3/4 → 1/1 | note:c s:piano ]",
+  "[ 1/1 → 5/4 | note:e s:piano ]",
+  "[ 5/4 → 3/2 | note:e s:piano ]",
+  "[ 3/2 → 7/4 | note:e s:piano ]",
+  "[ 7/4 → 2/1 | note:c s:piano ]",
+  "[ 2/1 → 9/4 | note:f s:piano ]",
+  "[ 9/4 → 5/2 | note:d s:piano ]",
+  "[ 5/2 → 11/4 | note:d s:piano ]",
+  "[ 11/4 → 3/1 | note:e s:piano ]",
+  "[ 3/1 → 13/4 | note:c s:piano ]",
+  "[ 13/4 → 7/2 | note:f s:piano ]",
+  "[ 7/2 → 15/4 | note:d s:piano ]",
+  "[ 15/4 → 4/1 | note:f s:piano ]",
+]
+`;
+
+exports[`runs examples > example "scramble" example index 1 1`] = `
+[
+  "[ 0/1 → 1/8 | note:c s:piano ]",
+  "[ 1/8 → 1/4 | note:d s:piano ]",
+  "[ 1/4 → 3/8 | note:d s:piano ]",
+  "[ 3/8 → 1/2 | note:c s:piano ]",
+  "[ 1/2 → 1/1 | note:g s:piano ]",
+  "[ 1/1 → 9/8 | note:e s:piano ]",
+  "[ 9/8 → 5/4 | note:e s:piano ]",
+  "[ 5/4 → 11/8 | note:e s:piano ]",
+  "[ 11/8 → 3/2 | note:c s:piano ]",
+  "[ 3/2 → 2/1 | note:g s:piano ]",
+  "[ 2/1 → 17/8 | note:f s:piano ]",
+  "[ 17/8 → 9/4 | note:d s:piano ]",
+  "[ 9/4 → 19/8 | note:d s:piano ]",
+  "[ 19/8 → 5/2 | note:e s:piano ]",
+  "[ 5/2 → 3/1 | note:g s:piano ]",
+  "[ 3/1 → 25/8 | note:c s:piano ]",
+  "[ 25/8 → 13/4 | note:f s:piano ]",
+  "[ 13/4 → 27/8 | note:d s:piano ]",
+  "[ 27/8 → 7/2 | note:f s:piano ]",
+  "[ 7/2 → 4/1 | note:g s:piano ]",
+]
+`;
+
 exports[`runs examples > example "scrub" example index 0 1`] = `
 [
   "[ 0/1 → 1/8 | s:swpad n:0 begin:0.1 speed:1 clip:1 ]",
@@ -8481,9 +8548,7 @@ exports[`runs examples > example "shrink" example index 3 1`] = `
 ]
 `;
 
-exports[`runs examples > example "shuffle
+exports[`runs examples > example "shuffle" example index 0 1`] = `
-Slices a pattern into the given number of parts, then plays those parts in random order.
-Each part will be played exactly once per cycle." example index 0 1`] = `
 [
   "[ 0/1 → 1/4 | note:c s:piano ]",
   "[ 1/4 → 1/2 | note:d s:piano ]",
@@ -8504,9 +8569,7 @@ Each part will be played exactly once per cycle." example index 0 1`] = `
 ]
 `;
 
-exports[`runs examples > example "shuffle
+exports[`runs examples > example "shuffle" example index 1 1`] = `
-Slices a pattern into the given number of parts, then plays those parts in random order.
-Each part will be played exactly once per cycle." example index 1 1`] = `
 [
   "[ 0/1 → 1/8 | note:c s:piano ]",
   "[ 1/8 → 1/4 | note:d s:piano ]",