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 .py and .rst files with doctest #445

Merged
merged 8 commits into from Nov 2, 2022
Merged

test .py and .rst files with doctest #445

merged 8 commits into from Nov 2, 2022

Conversation

niccokunzmann
Copy link
Member

This runs doctest on .py and rst files.
See #443

The tests should be failing at the moment.
To fix a doctest, please create a pull request to the doctest branch.

In contrary to #443, this runs doctest as part of the tests to make sure that the documentation is valid for all Python versions.

@coveralls
Copy link

coveralls commented Oct 10, 2022

Pull Request Test Coverage Report for Build 3231673072

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-92.9%) to 0.0%

Totals Coverage Status
Change from base Build 3213330057: -92.9%
Covered Lines: 0
Relevant Lines: 0

💛 - Coveralls

@niccokunzmann
Copy link
Member Author

If this is open for another 4 days, I would like to merge it to have progress.

@ale-rt
Copy link
Member

ale-rt commented Oct 21, 2022

It looks quite good to me but the branch needs a rebase.

@@ -10,6 +10,7 @@ usedevelop=True
deps =
pytest
coverage
hypothesis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one should do in the tests_require list that you can find in the setup.py file:

tests_require = []

Then the requirements_docs.txt file should install . [test] (untested)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your reply! Hm I do not know why hypothesis is even in there.

Here, it uses use_debelop=True and therewith does a pip install ..
We do have different tests running that have different dependencies. Using use-develop is what we do here. I think, changing this would go into an other PR as it is independent of doctest. If you think, that change is worth experimenting with, you can create a PR or an issue, I would say. I do not really see a difference at the moment.

What do you think?

@niccokunzmann
Copy link
Member Author

niccokunzmann commented Nov 2, 2022

Thanks for the review @ale-rt. I merged master.

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

3 participants