Skip to content

Commit c1f96e3

Browse files
Update scripts/populate_tox/README.md
Co-authored-by: Daniel Szoke <[email protected]>
1 parent 1e2b8af commit c1f96e3

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

scripts/populate_tox/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,25 @@ key can be used.
126126

127127
### `include`
128128

129-
Sometimes there are versions of packages that we explicitly don't want to test.
130-
One example is Starlite, which has two alpha prereleases of version 2.0.0, but
131-
there will never will be a stable 2.0 release, since development on Starlite
132-
has stopped and Starlite 2.0 eventually became Litestar.
129+
Sometimes we only want to consider testing some specific versions of packages.
130+
For example, the Starlite package has two alpha prereleases of version 2.0.0, but
131+
we do not want to test these, since Starlite 2.0 was renamed to Litestar.
133132

134133
The value of the `include` key expects a version specifier defining which
135-
versions should be considered for testing.
134+
versions should be considered for testing. For example, since we only want to test
135+
versions below 2.x in Starlite, we can use
136+
137+
```python
138+
"starlite": {
139+
"include": "<2",
140+
...
141+
}
142+
```
143+
144+
The `include` key can also be used to exclude a set of specific versions by using
145+
`!=` version specifiers. For example, the Starlite restriction above could equivalently
146+
be expressed like so:
147+
136148

137149
```python
138150
"starlite": {
@@ -141,6 +153,7 @@ versions should be considered for testing.
141153
}
142154
```
143155

156+
144157
## How-Tos
145158

146159
### Add a new test suite

0 commit comments

Comments
 (0)