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

Option to run doctests #379

Open
hombit opened this issue Feb 4, 2024 · 3 comments
Open

Option to run doctests #379

hombit opened this issue Feb 4, 2024 · 3 comments
Labels
question Further information is requested

Comments

@hombit
Copy link
Contributor

hombit commented Feb 4, 2024

Currently pytest looks into tests and runs tests from there. It would be also very convenient to run docstring examples as docstrings with CI and pre-commit. See pytest doctest docs here:
https://docs.pytest.org/en/4.6.x/doctest.html

@hombit
Copy link
Contributor Author

hombit commented Feb 6, 2024

I believe #381 is related to this one

@delucchi-cmu
Copy link
Contributor

Are you suggesting we add to the default test targets in the pyproject toml? Or just add some documentation in the pytest page about how you could set it up?

@delucchi-cmu delucchi-cmu added the question Further information is requested label Feb 9, 2024
@hombit
Copy link
Contributor Author

hombit commented May 6, 2024

@delucchi-cmu I suggest adding the default test target

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants