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.

Sign up for GitHub

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

Jump to bottom

update docs #17

Open
omaciel opened this issue May 12, 2014 · 1 comment
Open

update docs #17

omaciel opened this issue May 12, 2014 · 1 comment

Comments

@omaciel
Copy link
Owner

omaciel commented May 12, 2014

Need to review and clean up/update docs.
@Ichimonji10
Copy link
Contributor

I think the goal of "make this documentation usable to both the average newcomer and an experienced dev" has been accomplished. Also, the documentation is nicely maintainable these days, as the docs directory serves as a single, authoritative source for all documentation. Perhaps the API reference could include more usage examples, especially in the form of doctests?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@omaciel @Ichimonji10