tidalcycles / strudel

Web-based environment for live coding algorithmic patterns, incorporating a faithful port of TidalCycles to JavaScript
https://strudel.cc/
GNU Affero General Public License v3.0
579 stars 105 forks source link

add Pattern.every to the docs? #1094

Closed kasparsj closed 1 month ago

kasparsj commented 1 month ago

Coming from TidalCycles I had to dig into the code to find that every has been renamed to firstOf. I think better to have it clear in the docs.

Now I see it appears in the Reference tab, but initially I was search trough the Learn section and not finding.

yaxu commented 1 month ago

Looks good to me, is it still a draft?

felixroos commented 1 month ago

every is an alias of firstOf, so maybe add it using the @synonyms jsdoc tag?

kasparsj commented 1 month ago

every is an alias of firstOf, so maybe add it using the @synonyms jsdoc tag?

synonyms don't seem to show up in search though

felixroos commented 1 month ago

every is an alias of firstOf, so maybe add it using the @synonyms jsdoc tag?

synonyms don't seem to show up in search though

indeed, i didn't know that. so then we need to fix that: https://github.com/tidalcycles/strudel/issues/1099 adding all synonyms as separate headings would mean a lot of duplication / redundancy.

kasparsj commented 1 month ago

ok, good, closing this in favour of #1099