Commit e2fae48e5997025c2df13a31a05ac5d1a02299da
1 parent
4368e297
Adding prefix command to docs
Showing
2 changed files
with
2 additions
and
0 deletions
CHANGELOG.md
| 1 | ## Version 1.1 (in progress) | 1 | ## Version 1.1 (in progress) |
| 2 | * Added `app.parse_order()` with original parse order | 2 | * Added `app.parse_order()` with original parse order |
| 3 | +* Added `prefix_command()`, which is like `allow_extras` but instantly stops and returns. | ||
| 3 | 4 | ||
| 4 | ## Version 1.0 | 5 | ## Version 1.0 |
| 5 | * Cleanup using `clang-tidy` and `clang-format` | 6 | * Cleanup using `clang-tidy` and `clang-format` |
README.md
| @@ -194,6 +194,7 @@ There are several options that are supported on the main app and subcommands. Th | @@ -194,6 +194,7 @@ There are several options that are supported on the main app and subcommands. Th | ||
| 194 | * `.parsed()`: True if this subcommand was given on the command line | 194 | * `.parsed()`: True if this subcommand was given on the command line |
| 195 | * `.set_callback(void() function)`: Set the callback that runs at the end of parsing. The options have already run at this point. | 195 | * `.set_callback(void() function)`: Set the callback that runs at the end of parsing. The options have already run at this point. |
| 196 | * `.allow_extras()`: Do not throw an error if extra arguments are left over (Only useful on the main `App`, as that's the one that throws errors). | 196 | * `.allow_extras()`: Do not throw an error if extra arguments are left over (Only useful on the main `App`, as that's the one that throws errors). |
| 197 | +* `.prefix_command()`: Like `allow_extras`, but stop immediately on the first unrecognised item. It is ideal for allowing your app to be a "prefix" to calling another app. | ||
| 197 | 198 | ||
| 198 | ## Configuration file | 199 | ## Configuration file |
| 199 | 200 |