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

Write documentation #10

Closed

5 tasks done

HadrienG opened this issue May 11, 2017 · 1 comment

Assignees

Milestone

Owner

HadrienG commented May 11, 2017 •

edited

Loading

Issue to track the progress on the Roadmap item "Write documentation"

write docstrings for all functions
write inline comments for (i) making the code easier to follow (ii) document eventual obscure one-liners
update the README with (i) a brief intro, (ii) install instructions, (iii) basic usage
write complete documentation in a doc subdirectory
publish the doc to readthedocs

HadrienG added this to the 0.1.0-alpha milestone

HadrienG self-assigned this

HadrienG mentioned this issue

Open

20 tasks

Owner Author

HadrienG commented Jul 15, 2017

closed with 8446ffb

HadrienG closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment