renoise / definitions

LuaCATS definitions for the Renoise Lua API
4 stars 4 forks source link

Remaining definitions #12

Closed unlessgames closed 4 months ago

unlessgames commented 4 months ago

Transforming all the remaining files to an annotated version.

TODO

Overall pretty complete but the comments might need to be cut down or rephrased from the documentation format.

Hope it helps!

emuell commented 4 months ago

Thanks so much! This helps a lot and looks just perfect.

I'd merge this as is, and then use your Range() notation for the other already converted docs, and unify the headers. Then let's give this a good test run and fix/improve small things where necessary, maybe with the help of the others Renoisers.

Views probably also could be split into multiple files later on to ease navigation a bit?

unlessgames commented 4 months ago

Cheers!

Splitting the view_builder file might be a good idea, maybe split around static vs user controllable views? But I guess this file won't be read on its own much so it could be alright as is.

I forgot to mention that I left the ![]...REPLACE_URL tags for the images in that file (I assume they worked in the past), probably shouldn't have those in the reference but I'd keep the ASCII art because they are a nice touch.

Either way, you can search/match for REPLACE_URL to remove those lines.

emuell commented 4 months ago

Agree. It's unlikely that the docs are read, but at some point we'd like to create a html version of the docs. The file/folder structure could be useful for navigation then (as TOC).

Will take care of the REPLACE_URL things. Thanks!