Commit 3d405ef1639a918ea8798666e2b02eb9cef889c0
1 parent
0edf37b6
Improve boolean readme
Fixes #157. Fix the wording in the README about booleans.
Showing
1 changed file
with
4 additions
and
2 deletions
README.md
| @@ -111,8 +111,10 @@ though it was given on the command line. | @@ -111,8 +111,10 @@ though it was given on the command line. | ||
| 111 | 111 | ||
| 112 | Boolean options have a default implicit value of `"true"`, which can be | 112 | Boolean options have a default implicit value of `"true"`, which can be |
| 113 | overridden. The effect is that writing `-o` by itself will set option `o` to | 113 | overridden. The effect is that writing `-o` by itself will set option `o` to |
| 114 | -`true`. However, they can also be written with various strings using either | ||
| 115 | -`=value` or the next argument. | 114 | +`true`. However, they can also be written with various strings using `=value`. |
| 115 | +There is no way to disambiguate positional arguments from the value following | ||
| 116 | +a boolean, so we have chosen that they will be positional arguments, and | ||
| 117 | +therefore, `-o false` does not work. | ||
| 116 | 118 | ||
| 117 | ## Custom help | 119 | ## Custom help |
| 118 | 120 |