Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

softcut API docs should be more descriptive #979

Closed
andr-ew opened this issue Jan 19, 2020 · 2 comments
Closed

softcut API docs should be more descriptive #979

andr-ew opened this issue Jan 19, 2020 · 2 comments

Comments

@andr-ew
Copy link
Contributor

@andr-ew andr-ew commented Jan 19, 2020

I think a good chunk of these could use more detailed descriptions. I just wound up looking at source code to figure out what voice_sync did, which shouldn't be necessary.

It's also confusing that the commands are using colon notation here, while the functions used do not.

(maybe this is already on a TODO list somewhere)

@catfact
Copy link
Collaborator

@catfact catfact commented Jan 19, 2020

Not sure but I think the colon notation is applied automatically by luadoc when @classmod is used, or something

@catfact
Copy link
Collaborator

@catfact catfact commented Jan 30, 2020

added a lot to the docstrings for this module.

if there are specific confusions just lmk but i'll close this for now.

ldoc output is kinda fugly but that's a different problem.

softcut also needs an actual manual, a very different problem (which is why i don't feel a need to go any more crazy on documenting the lua API - anything more thorough should live with the library)

@catfact catfact closed this Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants