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.

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

Add doctests #25

Open
abhinav-upadhyay opened this issue Dec 14, 2018 · 0 comments
Open

Add doctests #25

abhinav-upadhyay opened this issue Dec 14, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@abhinav-upadhyay
Copy link
Contributor

abhinav-upadhyay commented Dec 14, 2018 •
edited
Loading

doctests are example code snippets in the doc string of the APIs and they can be tested like regular unit tests. Having doctests makes sure that our documentation is in sync with the API changes. We could add examples from the README in the doc strings to start with.
@abhinav-upadhyay abhinav-upadhyay added the enhancement New feature or request label Dec 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@abhinav-upadhyay