Commit a69230e
committed
🎨 Add descriptions to all
Previously, a part of the environments weren't documented in the
config, making it difficult for the newbies to figure out what
their purposes are. This patch sets the descriptions for all the
envs listed with the `tox -av` command, leveraging the dynamic
factor-dependent explanation fragments.
```console
default environments:
linting -> run pre-commit-defined linters under `python3`
py38 -> run the tests under `py38`
py39 -> run the tests under `py39`
py310 -> run the tests under `py310`
py311 -> run the tests under `py311`
py312 -> run the tests under `py312`
py313 -> run the tests under `py313`
pypy3 -> run the tests under `pypy3`
py38-pexpect -> run the tests against `pexpect` under `py38`
py38-xdist -> run the tests with pytest in parallel mode under `py38`
py38-unittestextras -> run the tests against the unit test extras under `py38`
py38-numpy -> run the tests against `numpy` under `py38`
py38-pluggymain -> run the tests against the bleeding edge `pluggy` from Git under `py38`
py38-pylib -> run the tests against `py` lib under `py38`
doctesting -> run the tests under `~/.pyenv/versions/3.12.3/envs/pytest-pyenv-py3.12.3/bin/python` including doctests
doctesting-coverage -> run the tests collecting coverage under `~/.pyenv/versions/3.12.3/envs/pytest-pyenv-py3.12.3/bin/python` including doctests
plugins -> run reverse dependency testing against pytest plugins under `~/.pyenv/versions/3.12.3/envs/pytest-pyenv-py3.12.3/bin/python`
py38-freeze -> test pytest frozen with `pyinstaller` under `py38`
docs -> build the documentation site under `~/src/github/pytest-dev/pytest/doc/en/_build/html` with `python3`
docs-checklinks -> check the links in the documentation with `python3`
py311-exceptiongroup -> run the tests against `exceptiongroup` under `py311`
additional environments:
regen -> regenerate documentation examples under `python3`
release -> do a release, required posarg of the version number
prepare-release-pr -> prepare a release PR from a manual trigger in GitHub actions
generate-gh-release-notes -> generate release notes that can be published as GitHub Release
nobyte -> run the tests in no-bytecode mode under `~/.pyenv/versions/3.12.3/envs/pytest-pyenv-py3.12.3/bin/python`
lsof -> run the tests with `--lsof` pytest CLI option under `~/.pyenv/versions/3.12.3/envs/pytest-pyenv-py3.12.3/bin/python`
```tox environments1 parent b08b6d1 commit a69230e
1 file changed
Lines changed: 27 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
29 | 43 | | |
30 | 44 | | |
31 | 45 | | |
| |||
72 | 86 | | |
73 | 87 | | |
74 | 88 | | |
| 89 | + | |
| 90 | + | |
75 | 91 | | |
76 | 92 | | |
77 | 93 | | |
| |||
81 | 97 | | |
82 | 98 | | |
83 | 99 | | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
84 | 103 | | |
85 | 104 | | |
86 | 105 | | |
| |||
102 | 121 | | |
103 | 122 | | |
104 | 123 | | |
| 124 | + | |
| 125 | + | |
105 | 126 | | |
106 | 127 | | |
107 | 128 | | |
| |||
113 | 134 | | |
114 | 135 | | |
115 | 136 | | |
| 137 | + | |
| 138 | + | |
116 | 139 | | |
117 | 140 | | |
118 | 141 | | |
| |||
130 | 153 | | |
131 | 154 | | |
132 | 155 | | |
| 156 | + | |
| 157 | + | |
133 | 158 | | |
134 | 159 | | |
135 | 160 | | |
| |||
154 | 179 | | |
155 | 180 | | |
156 | 181 | | |
| 182 | + | |
| 183 | + | |
157 | 184 | | |
158 | 185 | | |
159 | 186 | | |
| |||
0 commit comments