Skip to content

Commit

Permalink
rephrase warning section to explain better the issue.
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoav Caspi committed Jan 9, 2019
1 parent 149620f commit 2467831
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/en/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -889,8 +889,11 @@ 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.
.. 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.

Configuration file options may be overwritten in the command-line by using ``-o/--override``, which can also be
passed multiple times. The expected format is ``name=value``. For example::
Expand Down

0 comments on commit 2467831

Please sign in to comment.