Skip to content

Commit

Permalink
Improve testenv docs consistency (#3440)
Browse files Browse the repository at this point in the history
  • Loading branch information
thatch authored Nov 8, 2024
1 parent a442878 commit 08f2ac5
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Core settings
~~~~~~~~~~~~~

Core settings that affect all test environments or configure how tox itself is invoked are defined under the root table
in ``tox.toml`` and ``tox`` table in ``tox.ini`` section.
in ``tox.toml`` and ``tox`` section in ``tox.ini``.

.. tab:: TOML

Expand Down Expand Up @@ -202,8 +202,6 @@ Basic example
env_list = ["format", "3.13"]
format
py310
[env.format]
description = "install black in a virtual environment and invoke it on the current folder"
Expand Down Expand Up @@ -247,7 +245,7 @@ two run environments named ``format`` and ``3.13`` that should be run by default
specific environment.

The formatting environment and test environment are defined separately (via the ``env.format`` and ``env."3.13"`` in
TOML file; ``testenv:format`` and ``testenv:py310`` in INI file). For example to format the project we:
TOML file; ``testenv:format`` and ``testenv:py313`` in INI file). For example to format the project we:

- add a description (visible when you type ``tox list`` into the command line) via the :ref:`description` setting
- define that it requires the :pypi:`black` dependency with version ``22.3.0`` via the :ref:`deps` setting
Expand Down

0 comments on commit 08f2ac5

Please sign in to comment.