Tasklist: Undocumented Things

[lennart]

Things to be documented:

Current state as in 0.8-dev

Creating Patterns

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

Reference

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