Skip to content

Commit

Permalink
Disable coverage testing by default (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
rly authored Jan 25, 2024
1 parent 3a999da commit 11ae225
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 5 additions & 0 deletions {{ cookiecutter.namespace }}/NEXTSTEPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ replaced or removed.
new functions) and **integration tests** (e.g., write the new data types to file, read
the file, and confirm the read data types are equal to the written data types) is
highly encouraged.
- By default, the project is configured NOT to run code coverage as part of the tests.
Code coverage reporting is useful to help with creation of tests and report test coverage.
However, with this option enabled, breakpoints for debugging with pdb are being ignored.
To enable this option for code coverage reporting, uncomment out the following line in
your `pyproject.toml`: [line]()

8. You may need to modify `pyproject.toml` and re-run `python -m pip install -e .` if you
use any dependencies.
Expand Down
3 changes: 2 additions & 1 deletion {{ cookiecutter.namespace }}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ include = [
exclude = []

[tool.pytest.ini_options]
addopts = "--cov --cov-report html"
# uncomment below to run pytest with code coverage reporting. NOTE: breakpoints may not work
# addopts = "--cov --cov-report html"

[tool.codespell]
skip = "htmlcov,.git,.mypy_cache,.pytest_cache,.coverage,*.pdf,*.svg,venvs,.tox,hdmf-common-schema,./docs/_build/*,*.ipynb"
Expand Down

0 comments on commit 11ae225

Please sign in to comment.