Documentation configuration files #4609
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4609 +/- ##
=======================================
Coverage 95.75% 95.75%
=======================================
Files 111 111
Lines 24678 24678
Branches 2446 2446
=======================================
Hits 23630 23630
Misses 740 740
Partials 308 308
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #4609 +/- ##
=======================================
Coverage 95.75% 95.75%
=======================================
Files 111 111
Lines 24678 24678
Branches 2446 2446
=======================================
Hits 23630 23630
Misses 740 740
Partials 308 308
Continue to review full report at Codecov.
|
doc/en/reference.rst
Outdated
| @@ -889,6 +889,9 @@ Here is a list of builtin configuration options that may be written in a ``pytes | |||
| file, usually located at the root of your repository. All options must be under a ``[pytest]`` section | |||
| (``[tool:pytest]`` for ``setup.cfg`` files). | |||
|
|
|||
| .. warning:: usage of configuration file different than the canonical, i.e. ``pytest.ini`` | |||
There was a problem hiding this comment.
this warning should be specifically for setup.cfg tox and pytest use the same ini parser
There was a problem hiding this comment.
I see, I'm new to Github, can you suggest me how to do it?
- create a new PR?
- add new commit?
There was a problem hiding this comment.
Adding a new commit or amending and force pushing are all valid. 👍
doc/en/reference.rst
Outdated
| @@ -889,6 +889,9 @@ Here is a list of builtin configuration options that may be written in a ``pytes | |||
| file, usually located at the root of your repository. All options must be under a ``[pytest]`` section | |||
| (``[tool:pytest]`` for ``setup.cfg`` files). | |||
|
|
|||
| .. warning:: usage of configuration file different than the canonical, i.e. ``pytest.ini`` | |||
| can break other tools configurations. | |||
There was a problem hiding this comment.
My suggestion:
.. warning::
Usage of ``setup.cfg`` is not recommended unless for very simple use cases: ``.cfg``
files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track
down problems.
When possible, it is recommended to use the latter files to hold your pytest configuration.There was a problem hiding this comment.
Thanks. I like this suggestion :-)
|
Thanks! |
|
Ignoring AppVeyor because codecov is acting up again |
Fix #3375