Skip to content

Enable doctests on modules #111

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

Merged
merged 1 commit into from
May 4, 2023
Merged

Enable doctests on modules #111

merged 1 commit into from
May 4, 2023

Conversation

ajnelson-nist
Copy link
Member

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.

@ajnelson-nist ajnelson-nist added this to the 0.11.0 milestone May 4, 2023
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 ajnelson-nist marked this pull request as ready for review May 4, 2023 18:44
@ajnelson-nist ajnelson-nist requested a review from a team as a code owner May 4, 2023 18:44
@kchason kchason merged commit aeca9a4 into develop May 4, 2023
@ajnelson-nist ajnelson-nist deleted the enable_doctests branch May 5, 2023 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants