Skip to content

Commit 885944f

Browse files
committed
Docs: clarify how multiple values work for various options
I spent a long while wondering why comma-separated values wouldn't work for `CIBW_SKIP`.
1 parent e18a6e9 commit 885944f

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/options.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,11 @@ List of builds to build and skip. Each build has an identifier like `cp38-manyli
284284

285285
When both options are specified, both conditions are applied and only builds with a tag that matches `CIBW_BUILD` and does not match `CIBW_SKIP` will be built.
286286

287-
When setting the options, you can use shell-style globbing syntax, as per [fnmatch](https://docs.python.org/3/library/fnmatch.html) with the addition of curly bracket syntax `{option1,option2}`, provided by [bracex](https://pypi.org/project/bracex/). All the build identifiers supported by cibuildwheel are shown below:
287+
When setting the options, you can use shell-style globbing syntax, as per [fnmatch](https://docs.python.org/3/library/fnmatch.html) with the addition of curly bracket syntax `{option1,option2}`, provided by [bracex](https://pypi.org/project/bracex/).
288+
289+
Separate multiple selectors with a space, e.g. `cp36-macosx_x86_64 pp*`.
290+
291+
All the build identifiers supported by cibuildwheel are shown below:
288292

289293
<div class="build-id-table-marker"></div>
290294

@@ -361,8 +365,6 @@ See the [cibuildwheel 1 documentation](https://cibuildwheel.pypa.io/en/1.x/) for
361365
CIBW_SKIP: pp*
362366
```
363367

364-
Separate multiple selectors with a space.
365-
366368
!!! tab examples "pyproject.toml"
367369

368370
```toml
@@ -473,6 +475,7 @@ The build identifiers for those variants have a `t` suffix in their `python_tag`
473475
> Change the architectures built on your machine by default.
474476
475477
A list of architectures to build.
478+
Separate multiple architectures with a space.
476479

477480
On macOS, this option can be used to [cross-compile](faq.md#cross-compiling)
478481
between `x86_64`, `universal2` and `arm64`.
@@ -532,8 +535,6 @@ This option can also be set using the [command-line option](#command-line)
532535
CIBW_ARCHS_LINUX: "auto aarch64"
533536
```
534537

535-
Separate multiple archs with a space.
536-
537538
!!! tab examples "pyproject.toml"
538539

539540
```toml
@@ -814,8 +815,6 @@ Platform-specific environment variables are also available:<br/>
814815
CIBW_ENVIRONMENT_LINUX: BUILD_TIME="$(date)" SAMPLE_TEXT="sample text"
815816
```
816817

817-
Separate multiple values with a space.
818-
819818
!!! tab examples "pyproject.toml"
820819

821820
```toml
@@ -883,8 +882,6 @@ To specify more than one environment variable, separate the variable names by sp
883882
CIBW_ENVIRONMENT_PASS_LINUX: BUILD_TIME SAMPLE_TEXT
884883
```
885884

886-
Separate multiple values with a space.
887-
888885
!!! tab examples "pyproject.toml"
889886

890887
```toml
@@ -1580,6 +1577,9 @@ tests. This can be used to avoid having to redefine test dependencies in
15801577
`CIBW_TEST_REQUIRES` if they are already defined in `pyproject.toml`,
15811578
`setup.cfg` or `setup.py`.
15821579

1580+
Separate multiple items with a comma, e.g. `bar,baz,quux`,
1581+
just like you would when installing extras with `pip install foo[bar,baz,quux]`.
1582+
15831583
Platform-specific environment variables are also available:<br/>
15841584
`CIBW_TEST_EXTRAS_MACOS` | `CIBW_TEST_EXTRAS_WINDOWS` | `CIBW_TEST_EXTRAS_LINUX` | `CIBW_TEST_EXTRAS_PYODIDE`
15851585

@@ -1592,8 +1592,6 @@ Platform-specific environment variables are also available:<br/>
15921592
CIBW_TEST_EXTRAS: "test,qt"
15931593
```
15941594

1595-
Separate multiple items with a comma.
1596-
15971595
!!! tab examples "pyproject.toml"
15981596

15991597
```toml

0 commit comments

Comments
 (0)