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

Reference documentation #13

Closed
prcastro opened this issue Sep 6, 2015 · 0 comments
Closed

Reference documentation #13

prcastro opened this issue Sep 6, 2015 · 0 comments

Comments

@prcastro
Copy link
Owner

prcastro commented Sep 6, 2015

We need to write a reference, documenting each function/type/etc exported by the library. However, it should be automated, extracting the metadata from each function and putting into a markdown file. This way, we don't need to update the documentation by hand each time we write a new function.

@prcastro prcastro changed the title Reference on documentation Reference documentation Sep 6, 2015
@prcastro prcastro added this to the Version 1.0 milestone Sep 7, 2015
@prcastro prcastro closed this as completed Sep 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant