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

Test docstring examples #350

Merged
merged 7 commits into from
May 4, 2021
Merged

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented May 4, 2021

Description of the change

  • Add a build step to test the docstring examples using doctest via the pytest command pytest --doctest-modules.
  • Update pytest config accordingly.
  • Fix docstring examples accordingly.
  • Update contributing guide with tips for running docstring tests locally

Progress of the PR

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the
    unreleased section in doc/changelog.rst.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added documentation This relates to the documentation tests This relates to the tests labels May 4, 2021
@hakonanes hakonanes added this to the v0.4.0 milestone May 4, 2021
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes changed the title Start testing of docstring examples Test of docstring examples May 4, 2021
@hakonanes hakonanes changed the title Test of docstring examples Test docstring examples May 4, 2021
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit cf986df into pyxem:master May 4, 2021
@hakonanes hakonanes deleted the test-docstrings branch May 4, 2021 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation tests This relates to the tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant