Skip to content

Commit 87d8b0c

Browse files
PamelaMionelmc
authored andcommitted
Update config.rst wrt ignored .coveragerc settings
I took a while to figure out why coverage wasn't working correctly for our large project until yesterday, when I read the paragraph that called out the `.coveragerc` options that `pytest-cov` ignores. This PR makes that part of the documentation "pop" a bit more. I considered moving it under "Caveats", but decided that that would mean rewriting "Caveats" to have two separate issues, rather than the one that it currently explains.
1 parent da61b91 commit 87d8b0c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/config.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ For full details refer to the `coverage config file`_ documentation.
2121

2222
.. _`coverage config file`: https://coverage.readthedocs.io/en/latest/config.html
2323

24-
Note that this plugin controls some options and setting the option in the config file will have no
25-
effect. These include specifying source to be measured (source option) and all data file handling
26-
(data_file and parallel options).
24+
**Important Note :** This plugin controls some options and setting the option in the config file will have no
25+
effect. These include specifying source to be measured ("source" option) and all data file handling
26+
("data_file" and "parallel" options).
2727

2828
If you wish to always add pytest-cov with pytest, you can use ``addopts`` under ``pytest`` or ``tool:pytest`` section.
2929
For example: ::

0 commit comments

Comments
 (0)