Skip to content

Commit

Permalink
[#2217] clarify documentation for negatable options
Browse files Browse the repository at this point in the history
Closes #2217
  • Loading branch information
remkop committed Apr 10, 2024
1 parent 3eb773a commit 1dd8632
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions RELEASE-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Artifacts in this release are signed by Remko Popma (6601 E5C0 8DCC BB96).
* [#2053] [#2175] Remove unused extra format arguments. Thanks to [Michael Vorburger](https://github.com/vorburger) for the pull request.
* [#2054][#2176] Add Error Prone. Thanks to [Michael Vorburger](https://github.com/vorburger) for the pull request.
* [#2170] Use `...` vararg instead of array parameter to match overridden method signature. Thanks to [Michael Vorburger](https://github.com/vorburger) for the pull request.
* [#2217] DOC: Clarify documentation for negatable options. Thanks to [dbear496](https://github.com/dbear496) for raising this.
* [#2047] DEP: Bump andymckay/append-gist-action from 1fbfbbce708a39bd45846f0955ed5521f2099c6d to 6e8d64427fe47cbacf4ab6b890411f1d67c07f3e
* [#2091] DEP: Bump actions/checkout from 3.5.2 to 3.6.0
* [#2108] DEP: Bump actions/checkout from 3.6.0 to 4.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -838,7 +838,7 @@ For *nix-style long options, aliases have the prefix `no-` to the given names, f
For Java JVM-style options like `-XX:+PrintGCDetails`, the `:+` is turned into `:-` and vice versa.
Short option names are not given a negative alias by default. (This is <<Customizing Negatable Options,customizable>>.)

If the negated form of the option is found, for example `--no-verbose`, the value is set to the provided default. Otherwise, with a regular call, for example `--verbose`, it is set to the opposite of the default.
If the negated form of the option is found, for example `--no-verbose`, the value is set to `false`. Otherwise, with a regular call, for example `--verbose`, the value is set to `true`.

[TIP]
.Negatable options that are `true` by default
Expand Down

0 comments on commit 1dd8632

Please sign in to comment.