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

Improve doctests #157

Merged
merged 1 commit into from Oct 5, 2019
Merged

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Oct 5, 2019

This PR is not based on a specific issue, but contains the following changes:

  • Introduce conftest.py to add pytest fixture for doctest_namespace
    See https://docs.pytest.org/en/latest/doctest.html#doctest-namespace-fixture
  • Remove the "import semver" line in each doctest; this is covered in conftest.py now as a pytest fixture
  • Extend setup.cfg with --doctest-report ndiff
    Makes the output a bit nicer in case something goes wrong
  • Make sure, the docstrings are consistent:
    • First line is a summary
    • Followed by a linebreak and the description of the parameters
    • Optionally with a doctest

* Introduce conftest.py to add pytest fixture for doctest_namespace
  See https://docs.pytest.org/en/latest/doctest.html#doctest-namespace-fixture
* Remove the "import semver" line in each doctest; this is
  covered in conftest.py now as a pytest fixture
* Extend setup.cfg with --doctest-report ndiff
  Makes the output a bit nicer in case something goes wrong
@scls19fr scls19fr requested a review from k-bx October 5, 2019 14:10
@scls19fr scls19fr merged commit d8da482 into python-semver:master Oct 5, 2019
@tomschr tomschr deleted the feature/improve-doctests branch October 6, 2019 10:27
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.

None yet

2 participants