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.

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

Improve docs #8

Open
jcreinhold opened this issue Sep 3, 2021 · 0 comments
Open

Improve docs #8

jcreinhold opened this issue Sep 3, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jcreinhold
Copy link
Owner

jcreinhold commented Sep 3, 2021

📚 Documentation

Additional documentation needs to be added—with examples (that always run)—via docstrings to the user-facing functions.

See doctest and the pytest extension.

@jcreinhold jcreinhold added the enhancement New feature or request label Sep 3, 2021
@jcreinhold jcreinhold self-assigned this Sep 3, 2021
@jcreinhold jcreinhold added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant