Update CI to run doctest (docstring tests) and apply necessary fixes to docstrings #2933
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2933 +/- ##
=====================================
Coverage 99.7% 99.7%
=====================================
Files 302 302
Lines 28433 28433
=====================================
Hits 28340 28340
Misses 93 93
Continue to review full report at Codecov.
|
angela97lin
changed the title
| @@ -31,39 +31,41 @@ test-no-parallel: | |||
|
|
|||
| .PHONY: test-parallel | |||
| test-parallel: | |||
| pytest evalml/tests/automl_tests/parallel_tests/ --doctest-modules --doctest-continue-on-failure --timeout 300 --durations 0 | |||
| pytest evalml/tests/automl_tests/parallel_tests/ --timeout 300 --durations 0 | |||
There was a problem hiding this comment.
Not useful to have the --doctest-modules tag in these commands, since there are no docstrings in our tests that we want to test :)
angela97lin
requested review from
freddyaboulton,
bchen1116,
ParthivNaresh,
chukarsten,
eccabay and
jeremyliweishih
|
|
||
| .PHONY: git-test-other | ||
| git-test-other: | ||
| pytest evalml/tests --ignore evalml/tests/automl_tests/ --ignore evalml/tests/tuner_tests/ --ignore evalml/tests/model_understanding_tests/ --ignore evalml/tests/pipeline_tests/ --ignore evalml/tests/utils_tests/ --ignore evalml/tests/component_tests/test_prophet_regressor.py --ignore evalml/tests/component_tests/test_components.py --ignore evalml/tests/component_tests/test_utils.py -n 2 --durations 0 --timeout 300 --doctest-modules --cov=evalml --junitxml=test-reports/git-test-other-junit.xml --doctest-continue-on-failure | ||
| pytest evalml/tests --ignore evalml/tests/automl_tests/ --ignore evalml/tests/tuner_tests/ --ignore evalml/tests/model_understanding_tests/ --ignore evalml/tests/pipeline_tests/ --ignore evalml/tests/utils_tests/ --ignore evalml/tests/component_tests/test_prophet_regressor.py --ignore evalml/tests/component_tests/test_components.py --ignore evalml/tests/component_tests/test_utils.py -n 2 --durations 0 --timeout 300 --doctest-modules --cov=evalml --junitxml=test-reports/git-test-other-junit.xml | ||
| make doctests |
There was a problem hiding this comment.
I think it's ok to run as part of git-test-other!
nit-pick: Maybe we should make a note of it somewhere? So that we remember and new devs/users know what's happening. Not sure if the right place is contributing guidelines. We also have our own internal CI document?
|
Great idea @freddyaboulton! Updated internal docs, and will add a brief line in our contributing guidelines to add doctests if applicable. |
Options:
git-test-others. If we expand the suite, could be worth to add to each individual git-test command as we have for pytest. :)