Skip to content

docs: fix flag-pair separator and small typos in options guide #3510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hernanr2205 wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

docs: fix flag-pair separator and small typos in options guide #3510

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0ea801
docs: fix flag-pair separator and small typos in options guide
hernanr2205 May 21, 2026
ecbf879
docs: fix flag-pair separator in envvar caution note
hernanr2205 May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Use cases for this more explicit pattern include:
* Shell aliases can set a flag, then an invocation can add a negation of the
flag

If a forward slash(`/`) is contained in your option name already, you can split
If a forward slash (`/`) is contained in your option name already, you can split
the parameters using `;`. In Windows `/` is commonly used as the prefix
character.

Expand Down Expand Up @@ -703,7 +703,7 @@ Here are the rules used to parse environment variable values for flag options:
```{caution}
For boolean flags with a pair of values, the only recognized environment variable is the one provided to the `envvar` argument.

So an option defined as `--flag\--no-flag`, with a `envvar="FLAG"` parameter, there is no magical `NO_FLAG=<anything>` variable that is recognized. Only the `FLAG=<anything>` environment variable is recognized.
So an option defined as `--flag/--no-flag`, with an `envvar="FLAG"` parameter, there is no magical `NO_FLAG=<anything>` variable that is recognized. Only the `FLAG=<anything>` environment variable is recognized.
```

If the flag is activated, its value is set to `flag_value`. Otherwise, the value
Expand Down