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

Documentation Strategy #15

Open

IanMayo opened this issue Oct 31, 2019 · 0 comments

Member

IanMayo commented Oct 31, 2019

We should provide these types of documentation:

Introduction & overview - some content to go in the ReadMe on the welcome page
Commented samples on how to run the library, from the user perspective
Commenting on our library code, to help us (or others) maintain it

For the commented code, this tool looks quite cool: pycco

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