Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing documentation #58

Open
yaxu opened this issue Apr 13, 2022 · 1 comment
Open

Missing documentation #58

yaxu opened this issue Apr 13, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@yaxu
Copy link
Member

yaxu commented Apr 13, 2022 •
edited by felixroos

There's probably quite a few things missing at this point, lets make a list:

core

  • pure
  • cat
  • seq
  • stack
  • timeCat
  • slow
  • fast
  • early
  • late
  • legato
  • struct
  • euclid
  • euclidLegato
  • rev
  • iter
  • iterback
  • every
  • each TODO: remove and adjust every
  • when
  • .stack
  • .superimpose
  • .layer
  • .off
  • echoWith
  • echo
  • .seq
  • .cat
  • .add TODO: move to in-source doc
  • .sub TODO: move to in-source doc
  • .mul TODO: move to in-source doc
  • .div TODO: move to in-source doc
  • round
  • add
  • sub
  • mul
  • div
  • floor
  • ceil
  • apply
  • range
  • range2
  • rangex
  • chunk
  • chunkBack
  • fastGap
  • ply
  • chop
  • cpm
  • zoom
  • zoomArc
  • linger
  • color
  • segment
  • invert / inv
  • when
  • append
  • palindrome
  • juxBy
  • jux
  • edit (deleted)
  • bypass (same as hush?)
  • hush
  • duration (deprecated?)
  • legato
  • velocity
  • speak (experimental)
  • draw (deprecated)
  • pianoroll (@jarmitage)
  • restart
  • reset

signal

  • steady
  • signal
  • isaw
  • saw
  • sine
  • cosine
  • square
  • tri
  • rand
  • irand
  • chooseWith
  • chooseInWith
  • time
  • brand, brandBy
  • wchooseWith
  • wchooseCycles
  • perlinWith
  • perlin
  • degradeByWith
  • degradeBy
  • degrade
  • undegradeBy
  • undegrade
  • sometimesBy
  • sometimesByPre ?
  • sometimes
  • sometimesPre ?
  • someCyclesBy
  • often
  • rarely
  • almostNever
  • almostAlways
  • never
  • always

webaudio

  • s
  • attack decay sustain release
  • samples
  • clip
  • gain
  • cutoff / resonance
  • hcutoff / hresonance
  • bandf / bandq
  • vowel
  • pan
  • coarse
  • shape
  • crush
  • freq
  • speed
  • begin / end
  • delay delayfeedback delaytime
  • unit (doesn't do much atm)
  • nudge
  • cut
  • loop
  • loopAt
  • orbit
  • room / roomsize
  • soundfont (experimental)

tonal

  • transpose
  • scale
  • scaleTranspose
  • voicings
  • rootNotes

midi

osc

  • osc

xen

more

  • pianoroll (@jarmitage )
  • spiral
  • theme
  • fontFamily
  • fontSize
@felixroos felixroos added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 24, 2022
@felixroos felixroos pinned this issue Aug 6, 2022
This was referenced Sep 17, 2022
Merged
Merged
@felixroos felixroos changed the title Missing tutorial documentation Missing documentation Jan 12, 2023
@felixroos
Copy link
Collaborator

felixroos commented Jan 12, 2023 •
edited

There is now an auto generated version of this list here: https://github.com/tidalcycles/strudel/blob/main/undocumented.json which can be regenerated by via npm run report-undocumented , which runs https://github.com/tidalcycles/strudel/blob/main/undocumented.mjs which parses all source files for exports and cross checks them with the jsdoc comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yaxu @felixroos