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

Improve documentation #1

Open
8 tasks
orome opened this issue Jan 1, 2016 · 0 comments
Open
8 tasks

Improve documentation #1

orome opened this issue Jan 1, 2016 · 0 comments
Assignees
@orome
Labels
enhancement

Comments

@orome
Copy link
Owner

orome commented Jan 1, 2016 •
edited
Loading

  • Write better usage messages.
  • Add more complete comments in the code.
  • Add descriptions to the demo notebook.
  • Add some examples to the readme.
  • Add more links to online resources (e.g. Oekaki sites)
  • Add example of image solution (vs. QR code)
  • Add to description of package and each function
  • Improve variable names
@orome orome self-assigned this Jan 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orome orome

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@orome