From e4f4fe81aed0ef44f8c1d0da123ee3186ddf9b1d Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Mon, 19 Sep 2022 23:21:55 +0200 Subject: [PATCH] doc: iterBack --- packages/core/pattern.mjs | 11 ++++++++--- tutorial/tutorial.mdx | 2 ++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/packages/core/pattern.mjs b/packages/core/pattern.mjs index 3d761dc3..86f6405f 100644 --- a/packages/core/pattern.mjs +++ b/packages/core/pattern.mjs @@ -1170,8 +1170,6 @@ export class Pattern { * @name iter * @memberof Pattern * @returns Pattern - * @param {number} divide number of subdivisions - * @param {boolean} back if true, iterate backwards * @example * note("0 1 2 3".scale('A minor')).iter(4).out() */ @@ -1179,7 +1177,14 @@ export class Pattern { return slowcat(...listRange(0, times - 1).map((i) => (back ? this.late(i / times) : this.early(i / times)))); } - // known as iter' in tidalcycles + /** + * Like `iter`, but plays the subdivisions in reverse order. Known as iter' in tidalcycles + * @name iterBack + * @memberof Pattern + * @returns Pattern + * @example + * note("0 1 2 3".scale('A minor')).iterBack(4).out() + */ iterBack(times) { return this.iter(times, true); } diff --git a/tutorial/tutorial.mdx b/tutorial/tutorial.mdx index 1f1c02a0..4c92bf84 100644 --- a/tutorial/tutorial.mdx +++ b/tutorial/tutorial.mdx @@ -504,6 +504,8 @@ The following functions modify a pattern temporal structure in some way. {{ 'Pattern.iter' | jsdoc }} +{{ 'Pattern.iterBack' | jsdoc }} + ## Conditional Modifiers {{ 'Pattern.every' | jsdoc }}