Tasklist: Undocumented Things

[lennart]

Things to be documented:

Current state as in 0.8-dev

Creating Patterns

• [ ] Euclid
  • [x] euclidian rhythm params as patterns
  • [ ] e'
  • [ ] en
  • [x] the shift parameter
• [x] Transitions

  Reference

• [ ] Pattern
  • [ ] compress
  • [x] degrade
  • [ ] unDegradeBy
  • [ ] discretise
  • [ ] enumerate
  • [ ] envL
  • [ ] envLR
  • [ ] envEq
  • [ ] envEqR
  • [ ] fadeIn
  • [ ] fadeIn'
  • [ ] fadeOut
  • [ ] fadeOut'
  • [ ] ghost
  • [ ] grp
  • [ ] inside
  • [ ] index
  • [x] jux
  • [ ] jux4
  • [ ] jux'
  • [x] juxBy
  • [ ] juxcut
  • [ ] lindenmayer
  • [ ] stutter
  • [ ] echo/double
  • [ ] triple
  • [ ] quad
  • [x] spread
  • [ ] spreadf
  • [ ] protate
  • [ ] prr
  • [ ] prrw
  • [ ] prw
  • [ ] prot
  • [ ] preplace, prep
  • [ ] preplaceWith
  • [ ] off
  • [ ] offadd
  • [ ] slice
  • [ ] randslice
  • [ ] scan
  • [ ] stretch
• [ ] Sample
  • [x] stut
  • [x] stut'
  • [x] striate
  • [ ] striateO
  • [x] striateL
• [x] Conditional
  • [x] ifp
  • [x] mask
  • [x] when
• [x] Transitions
  • [x] mortal
  • [x] wash
  • [x] jump
  • [x] jumpIn
  • [x] jumpIn'
  • [x] jumpMod
  • [x] clutch
  • [x] clutchIn
  • [x] anticipate
  • [x] anticipateIn
  • [x] histpan
  • [x] mortal
  • [x] superwash
  • [x] wait
  • [x] wash
  • [x] xfade
  • [x] xfadeIn
• [ ] Compositions
  • [x] randcat
  • [x] stack
  • [ ] stackwith
  • [ ] step
  • [ ] steps
  • [ ] permstep
  • [ ] pick
  • [ ] overlay
  • [ ] samples
  • [ ] samples'
  • [ ] struct
  • [ ] weave'
• [ ] Synth Params
  • [ ] begin "-1"
  • [ ] loop
  • [ ] offset
• [ ] Utility
  • [ ] choose
  • [ ] make
  • [x] scale
  • [ ] merge
  • [ ] mergelists
  • [ ] metronome
  • [ ] points
  • [x] up
  • [x] pequal
  • [x] run
  • [ ] segment
  • [ ] sig
  • [ ] split
  • [ ] tom
  • [ ] unwrap
• [ ] Continuous Patterns
  • [ ] sinerat
  • [ ] sawrat
  • [ ] trirat

[lennart]

If you start to document parts of the above list, please let us know…

[lennart]

I'll starting to document the general idea of transitions within "Creating Patterns"…

[lennart]

ok, so the first shot at transitions is online.

[bgold-cosmos]

e' (and en) go with the Euclidean stuff, pick and the sample variants should go with steps and fit, so I think the compositions section is probably best.

I don't know if unDegradeBy is really useful by itself - it's a complement to degradeBy that's mainly used as a convenience function for sometimesBy and its variants.

I'll try to update docs for at least my own creations (striateL, the jump transitions, begin -1 and loop) when I have more than a few minutes...

[lennart]

I guess we should stick to having a menu entry for the standard version of each function and document the ' version or variations within each of these paragraphs.

This way we won't be having that many menu entries.

Same could go for the In variants, like xfadeIn and anticipateIn

I try to update the above list to reflect this, i.e. moving variations a level below the standard version (jux is one such example)

[calumgunn]

I'm starting a couple of the Utility bits..

[calumgunn]

All Utility bits are in!

[lennart]

transitions are mostly documented in code already, I'll be moving them over to here

[lennart]

transition docs have pull requests now, will continue with "Conditional"

[lennart]

conditional docs have pull request now and are in tidalcycles/tidalcycles.github.io 0.8-dev continuing with the rest of Sample striateO and stut'

[lennart]

we should look into getting at least function docs in tidal 0.9-dev ready first, then update these auto(manually)