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

Docs: Provide example calculations and use cases #2

Open

drsteve opened this issue Sep 27, 2018 · 0 comments

Labels

Owner

drsteve commented Sep 27, 2018

Current documentation is sparse. It would be helpful to users to provide:

Simple example calculations in the docstrings
Some example use cases, possibly as scripts in an examples folder, or as Jupyter notebooks, or as pages in documentation (at the github.io web page)

drsteve added the documentation label

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