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

[Optional]: API Example usage #125

Open

g-walley opened this issue Jan 13, 2023 · 0 comments

Labels

Milestone

Owner

g-walley commented Jan 13, 2023

Add an example usage section to the function docstrings so that the auto api generated documents contain that information as well.

Start with the core functionality, and then work down into the less common functions.

g-walley added the documentation label

g-walley added this to the Paper/v1.0 milestone

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