Enable doctests on modules #111
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
This patch enables review of Python code inlined in the `case-utils` modules' docstrings. An initial docstring test is also included, because `pytest` reports an error if it is called and no tests are found. References: * https://docs.pytest.org/en/7.1.x/how-to/doctest.html Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist
force-pushed
the
enable_doctests
branch
from
cb8df5a to
9397f13
Compare
kchason
approved these changes
May 4, 2023
ajnelson-nist
added a commit
to usnistgov/CASE-Implementation-PROV-O
that referenced
this pull request
Jun 12, 2025
This patch enables `pytest`'s doctest mode and adds a first doctest to ensure `pytest` doesn't fail due to finding no tests to run. Follow-on patches will add new functions with more demanding doctests. No effects were observed on Make-managed files. References: * https://docs.pytest.org/en/7.1.x/how-to/doctest.html * casework/CASE-Utilities-Python#111 Signed-off-by: Alex Nelson <[email protected]>
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.
Please see the first patch message for this PR's rationale.
Another PR will be filed soon to exercise doctests, and this PR will be merged into that PR's branch to demonstrate that doctests pass.