From c3e38ca6c67b4a014a7723beff740caac547a11c Mon Sep 17 00:00:00 2001 From: Joe Rickerby Date: Sun, 14 Nov 2021 19:01:07 +0000 Subject: [PATCH] Add note in docs about placeholders --- docs/options.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/options.md b/docs/options.md index 3b9aaeb36..53ff1c4f5 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1259,6 +1259,10 @@ Platform-specific environment variables are also available:
« subprocess_run("cibuildwheel", "--help") » ``` +## Placeholders + +Some options support placeholders, like `{project}`, `{package}` or `{wheel}`, that are substituted by cibuildwheel before they are used. If, for some reason, you need to write the literal name of a placeholder, e.g. literally `{project}` in a command that would ordinarily substitute `{project}`, prefix it with a hash character - `#{project}`. This is only necessary in commands where the specific string between the curly brackets would be substituted - otherwise, strings not modified. +