-
Notifications
You must be signed in to change notification settings - Fork 147
API review
brian crabtree edited this page Jan 11, 2021
·
4 revisions
- 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...
- clarify sync doc
- add helper function for clock.sleep(clock.get_beats_ms(x)) ?
- 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
(ok!)
- some missing docs
- needs a description
-
gen
needs description
- needs a description
- needs a description
(ok!)
- camelcase lib (but functions are snake)
(ok!)
- 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
- looks good, but there's a pretty wide range of functions in here. not sure if we should consider categorizing?
(ok?)
- 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?
(probably fine?)
- this is problematic as it reflects the backend functions which are handled by the menu system, not the user-facing functions
- metamethod description is complicated but i guess that's reality
(ok?)
(ok?)
(ok?)
- there's a function to send to crone, but the description says sclang?
- 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
(ok?)
(ok?)
- this is effectively obsolete and we should consider removing it
(ok?)
- camelcase name
- UI category
- docs look good
- needs description
- needs more description
monome.org