diff --git a/packages/core/pattern.mjs b/packages/core/pattern.mjs index 918a924b..a8a4f7da 100644 --- a/packages/core/pattern.mjs +++ b/packages/core/pattern.mjs @@ -2531,7 +2531,7 @@ export function _polymeterListSteps(steps, ...args) { * @param {any[]} patterns one or more patterns * @example * // the same as "{c d, e f g}%4" - * s_polymeterSteps(4, "c d", "e f g") + * s_polymeterSteps(4, "c d", "e f g").note() */ export function s_polymeterSteps(steps, ...args) { if (args.length == 0) { @@ -2549,8 +2549,8 @@ export function s_polymeterSteps(steps, ...args) { * *EXPERIMENTAL* - Combines the given lists of patterns with the same pulse, creating polymeters when different sized sequences are used. * @synonyms pm * @example - * // The same as "{c eb g, c2 g2}" - * s_polymeter("c eb g", "c2 g2") + * // The same as note("{c eb g, c2 g2}") + * s_polymeter("c eb g", "c2 g2").note() * */ export function s_polymeter(...args) { @@ -2579,6 +2579,8 @@ export function s_polymeter(...args) { /** Sequences patterns like `seq`, but each pattern has a length, relative to the whole. * This length can either be provided as a [length, pattern] pair, or inferred from * the pattern's 'tactus', generally inferred by the mininotation. Has the alias `timecat`. + * @name s_cat + * @synonyms timeCat, timecat * @return {Pattern} * @example * s_cat([3,"e3"],[1, "g3"]).note() diff --git a/website/src/pages/learn/factories.mdx b/website/src/pages/learn/factories.mdx index 0d93fb21..a823bfed 100644 --- a/website/src/pages/learn/factories.mdx +++ b/website/src/pages/learn/factories.mdx @@ -11,15 +11,15 @@ import { JsDoc } from '../../docs/JsDoc'; The following functions will return a pattern. These are the equivalents used by the Mini Notation: -| function | mini | -| ------------------------------ | ---------------- | -| `cat(x, y)` | `""` | -| `seq(x, y)` | `"x y"` | -| `stack(x, y)` | `"x,y"` | -| `timeCat([3,x],[2,y])` | `"x@3 y@2"` | -| `polymeter([a, b, c], [x, y])` | `"{a b c, x y}"` | -| `polymeterSteps(2, x, y, z)` | `"{x y z}%2"` | -| `silence` | `"~"` | +| function | mini | +| -------------------------------- | ---------------- | +| `cat(x, y)` | `""` | +| `seq(x, y)` | `"x y"` | +| `stack(x, y)` | `"x,y"` | +| `s_cat([3,x],[2,y])` | `"x@3 y@2"` | +| `s_polymeter([a, b, c], [x, y])` | `"{a b c, x y}"` | +| `s_polymeterSteps(2, x, y, z)` | `"{x y z}%2"` | +| `silence` | `"~"` | ## cat @@ -45,21 +45,21 @@ As a chained function: -## timeCat +## s_cat - + ## arrange -## polymeter +## s_polymeter - + -## polymeterSteps +## s_polymeterSteps - + ## silence