Skip to content

Commit a6256e2

Browse files
committed
Add descriptions to the tox environments. Closes jaraco/skeleton#91.
1 parent b02bf32 commit a6256e2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

tox.ini

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[testenv]
2+
description = perform primary checks (tests, style, types, coverage)
23
deps =
34
setenv =
45
PYTHONWARNDEFAULTENCODING = 1
@@ -9,6 +10,7 @@ extras =
910
testing
1011

1112
[testenv:diffcov]
13+
description = run tests and check that diff from main is covered
1214
deps =
1315
diff-cover
1416
commands =
@@ -17,6 +19,7 @@ commands =
1719
diff-cover coverage.xml --compare-branch=origin/main --fail-under=100
1820

1921
[testenv:docs]
22+
description = build the documentation
2023
extras =
2124
docs
2225
testing
@@ -26,6 +29,7 @@ commands =
2629
python -m sphinxlint
2730

2831
[testenv:finalize]
32+
description = assemble changelog and tag a release
2933
skip_install = True
3034
deps =
3135
towncrier
@@ -36,6 +40,7 @@ commands =
3640

3741

3842
[testenv:release]
43+
description = publish the package to PyPI and GitHub
3944
skip_install = True
4045
deps =
4146
build

0 commit comments

Comments
 (0)