Add better doctest integration into pytest #228
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppkt
approved these changes
Mar 15, 2020
* Fix typos in `README.rst`.
* Move `coerce()` function into separate file; this was needed
so it can be both included into the documentation and inside
`conftest.py`.
* In `docs/usage.rst`:
- Fix typos
- Add missing semver module name as prefix
- Slightly rewrite some doctests which involves dicts
(unfortunately, order matters still in Python2)
* In `setup.cfg`:
- Add `--doctest-glob` option to look for all `*.rst` files.
- Add `testpaths` key to restrict testing paths to current dir
and `docs`.
* Update `CHANGELOG.rst`
088045a to
6669ba0
Compare
|
I will merge this PR tomorrow if noone objects. 😉 |
|
As nobody objected and it doesn't involve a lot of magic, I'm going to merge it now. |
|
+1 sorry I'm very busy because of COVID-19 in France. Setting up online courses with our Moodle platform. |
|
@scls19fr No problem. 👍 I hope I wasn't too quick for this. I leave more time for the other pull requests as they need more time to review. 😉 Wish you all the best! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is not based on a specific issue; it just evolved after having the idea of better integrate doctests in our documentation with pytest. 😉
Our documentation contains some examples which can be considered as doctests. As pytest supports doctests, we could use this features to check if the examples in our documentation are still correct.
This PR contains the following changes:
README.rst.coerce()function into separate file; this was needed so it can be both included into the documentation and insideconftest.py.docs/usage.rst:setup.cfg:--doctest-globoption to look for all*.rstfiles.testpathskey to restrict testing paths to current dir anddocs.I think, this is a huge benefit as it reduces typos in our documentation or prevents outdated information (they would be reported as errors).