python-project-template icon indicating copy to clipboard operation
python-project-template copied to clipboard
verified publisher icon lincc-frameworks

Option to run doctests

Open hombit opened this issue 2 years ago • 3 comments

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 avatar Feb 04 '24 17:02 hombit

I believe #381 is related to this one

hombit avatar Feb 06 '24 14:02 hombit

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 avatar Feb 07 '24 13:02 delucchi-cmu

@delucchi-cmu I suggest adding the default test target

hombit avatar May 06 '24 18:05 hombit

Raised again on a LSDB + CMU HCI discussion

hombit avatar Apr 02 '25 23:04 hombit