search

monome / norns

norns is many sound instruments.
http://monome.org
GNU General Public License v3.0
614 stars 144 forks source link

docs: missing functions #1466

Open tehn opened 2 years ago

tehn commented 2 years ago

[e.g.] the entire norns table is not documented and there are a few very user-relevant functions in there, such as the system call with callback norns.system_cmd = function(cmd, callback)

https://github.com/monome/norns/blob/main/lua/core/norns.lua#L206

it was a shortcut to put this function in the norns table, but i'm not sure if there are enough other functions meriting a system library or similar.

needless to say, this should be documented so people can find it.

catfact commented 2 years ago

i was reminded that all the C-defined functions in _norns are missing API docs.

not all of these are safe for use in scripts, but some are. in any case they should be documented outside of weaver.c source (which contains FIXME to that effect.)

https://github.com/monome/norns/blob/main/matron/src/weaver.c#L288