Skip to content

Commit 972c23d

Browse files
committed
Add descriptions to tox environments
With that we can expose the contributer to `tox -av` in the contributers guidelines.
1 parent 95891fa commit 972c23d

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/src/contributing.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@ Then this package itself
2626
pip install -e .
2727
2828
This install the package in development mode, making it importable globally and allowing
29-
you to edit the code and directly use the updated version.
29+
you to edit the code and directly use the updated version. To see a list of all
30+
supported tox environments please use
31+
32+
.. code-block:: bash
33+
34+
tox -av
3035
3136
Running the tests
3237
-----------------

tox.ini

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ lint_folders =
1212

1313

1414
[testenv:build]
15-
# builds the package and checks integrity
15+
description = Builds the package and checks integrity
1616

1717
usedevelop = true
1818
deps =
@@ -29,6 +29,7 @@ commands =
2929
check-manifest {toxinidir}
3030

3131
[testenv:tests]
32+
description = Runs the tests
3233
usedevelop = true
3334
changedir = tests
3435
deps =
@@ -51,6 +52,7 @@ commands_post =
5152
coverage xml
5253

5354
[testenv:lint]
55+
description = Checks the code and doc for programmatic and stylistic errors
5456
skip_install = true
5557
deps =
5658
black
@@ -87,6 +89,7 @@ commands =
8789
isort {[tox]lint_folders}
8890

8991
[testenv:docs]
92+
description = Builds the documentation
9093
usedevelop = true
9194
deps =
9295
-r docs/requirements.txt

0 commit comments

Comments
 (0)