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: run doctest on rst files in docs/ #1875

Merged
merged 1 commit into from
May 4, 2022

Conversation

aucampia
Copy link
Member

@aucampia aucampia commented Apr 30, 2022

Summary of changes

Currently there are only two files with doctests inside, but it is best
that we always run doctests just to ensure things are sane.

Other changes:

  • added doctest: +SKIP to make doctests inside docs/rdf_terms.rst
    pass.

Fixes #1791

Checklist

  • Checked that there aren't other open pull requests for
    the same change.
  • Checked that all tests and type checking passes.
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

@aucampia aucampia force-pushed the iwana-20220430T2337-doctest_docs branch 2 times, most recently from 9f4648d to cf9d66f Compare April 30, 2022 21:56
@aucampia aucampia requested a review from a team April 30, 2022 23:01
Currently there are only two files with doctests inside, but it is best
that we always run doctests just to ensure things are sane.

Other changes:

- added `doctest: +SKIP` to make doctests inside `docs/rdf_terms.rst`
  pass.

Fixes RDFLib#1791
@aucampia aucampia force-pushed the iwana-20220430T2337-doctest_docs branch from cf9d66f to 9ecd3dd Compare May 3, 2022 20:09
@coveralls
Copy link

Coverage Status

Coverage increased (+0.005%) to 88.238% when pulling 9ecd3dd on aucampia:iwana-20220430T2337-doctest_docs into 7ef3acf on RDFLib:master.

@aucampia aucampia merged commit 8c0e74e into RDFLib:master May 4, 2022
@aucampia
Copy link
Member Author

aucampia commented May 4, 2022

Merged with only 1 review as this essentially just adds more tests.

@aucampia aucampia deleted the iwana-20220430T2337-doctest_docs branch May 7, 2022 09:30
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.

Run doctest on docs in docs folder
2 participants