Skip to content

Commit

Permalink
remove Caveats
Browse files Browse the repository at this point in the history
  • Loading branch information
blueyed committed Mar 30, 2019
1 parent 7c0d4c9 commit 2d2aec1
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,6 @@ For example: ::
[tool:pytest]
addopts = --cov=<project-name> --cov-report html

Caveats
=======

A 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 your coverage configuration in ``tox.ini`` or ``setup.cfg`` it is paramount
that you also use ``--cov-config=tox.ini`` or ``--cov-config=setup.cfg``.

You might not be affected but it's unlikely that you won't ever use ``chdir`` in a test.

Reference
=========

Expand Down

0 comments on commit 2d2aec1

Please sign in to comment.