Skip to content

docs: improve configuration docs #672

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+2 −2
Open

docs: improve configuration docs #672

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a60ad4
Improve configuration docs
tserg Jan 21, 2025
8d296ac
Update docs/config.rst
tserg Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/config.rst
View file
Original file line number Diff line number Diff line change
@@ -48,14 +48,14 @@ Or for ``pyproject.toml``: ::
Caveats
=======

A unfortunate consequence of coverage.py's history is that ``.coveragerc`` is a magic name: it's the default file but it also
An unfortunate consequence of coverage.py's history is that ``.coveragerc`` is a magic name: it's the default file but it also
means "try to also lookup coverage configuration in ``tox.ini`` or ``setup.cfg``".

In practical terms this means that if you have multiple configuration files around (``tox.ini``, ``pyproject.toml`` or ``setup.cfg``) you
might need to use ``--cov-config`` to make coverage use the correct configuration file.

Also, if you change the working directory and also use subprocesses in a test you might also need to use ``--cov-config`` to make pytest-cov
will use the expected configuration file in the subprocess.
use the expected configuration file in the subprocess.

Reference
=========