Skip to content

API review

brian crabtree edited this page Jan 11, 2021 · 4 revisions

DOCS

  • issue of categorization, as it seems less than ideal to have a flat list of libs without any sense of sorting (ie, main stuff like screen, midi, etc and then other things like intonation, elca... and then the utils...

clock

  • clarify sync doc
  • add helper function for clock.sleep(clock.get_beats_ms(x)) ?

crow

  • input and output functions not listed
  • core.crow.ii_actions is in a separate file
  • core.crow.ii_events also
  • lib.crow.asl needs docs

softcut

(ok!)

lib.container.*

  • some missing docs

er

  • needs a description
  • gen needs description

filters

  • needs a description

formatters

  • needs a description

intonation

(ok!)

MusicUtil

  • camelcase lib (but functions are snake)

tabutil

(ok!)

lib.test.luaunit

  • ldoc rendering (lib.test.luaunit) --- this is in its own folder, for any reason?
  • this file is huge, and almost all of the functions are not documented
  • tons of commented out code in here

util

  • looks good, but there's a pretty wide range of functions in here. not sure if we should consider categorizing?

arc

(ok?)

audio

  • generally it is recommended that people interface with most of these via the param system, so i guess add text at top to suggest this?

controlspec

(probably fine?)

encoders

  • this is problematic as it reflects the backend functions which are handled by the menu system, not the user-facing functions

engine

  • metamethod description is complicated but i guess that's reality

grid

(ok?)

metro

(ok?)

midi

(ok?)

osc

  • there's a function to send to crone, but the description says sclang?

control

  • this is the only param type that has documentation, and it's presented top-level instead of params.control (if that's what makes sense?)
  • generally this probably shouldn't even be here because the user-facing interface is through paramset and this isn't used directly

paramset

(ok?)

screen

(ok?)

beatclock

  • this is effectively obsolete and we should consider removing it

elca

(ok?)

EnvGraph, FilterGraph, Graph, UI

  • camelcase name
  • UI category
  • docs look good

pattern

  • needs description

voice

  • needs more description