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

Replace doctests with unit tests #131

Closed
jace opened this issue Jul 20, 2017 · 2 comments
Closed

Replace doctests with unit tests #131

jace opened this issue Jul 20, 2017 · 2 comments
Labels

Comments

@jace
Copy link
Member

jace commented Jul 20, 2017

Doctests make documentation unnecessarily verbose, and are often incompatible between Python 2 and 3 because of differences in repr. They also can't be run in isolation to test one thing at a time. All doctests should be replaced with unit tests. Replacement is easy as each line can be reproduced as an assertEqual.

@jace
Copy link
Member Author

jace commented Feb 27, 2018

The problems with doctests are no longer relevant since the switch to pytest. However, the case remains that they make documentation ugly. pytest also makes it easier to write tests, so we should just switch anyway.

@jace jace added the tests label Feb 27, 2018
@jace
Copy link
Member Author

jace commented Jul 29, 2019

This is now the subject of #237.

@jace jace closed this as completed Jul 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant