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

Specification for Scheme/LilyPond function documentation #20

Open
uliska opened this issue Jun 10, 2017 · 0 comments
Open

Specification for Scheme/LilyPond function documentation #20

uliska opened this issue Jun 10, 2017 · 0 comments

Comments

@uliska
Copy link
Contributor

uliska commented Jun 10, 2017

We need a specification how to document public-facing functions in LilyPond and Scheme files. From this doc-comments regular documentation has to be generated later, ideally one would be able to use existing tools to do that.

The documentation has to provide the following information (to be discussed and completed):

  • function name
  • return type
  • argument names/types (with description)
  • general function description
  • more?

Blocks #26

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant