Skip to content

Test docstring examples#350

Merged
hakonanes merged 7 commits into
pyxem:masterfrom
hakonanes:test-docstrings
May 4, 2021
Merged

Test docstring examples#350
hakonanes merged 7 commits into
pyxem:masterfrom
hakonanes:test-docstrings

Conversation

@hakonanes

@hakonanes hakonanes commented May 4, 2021

Copy link
Copy Markdown
Member

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.

hakonanes added 2 commits May 4, 2021 18:03
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 labels May 4, 2021
@hakonanes hakonanes added this to the v0.4.0 milestone May 4, 2021
hakonanes added 3 commits May 4, 2021 18:17
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
hakonanes added 2 commits May 4, 2021 20:06
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant