Skip to content

Commit

Permalink
Add new documentation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
shadowspawn authored and abetomo committed Apr 7, 2023
1 parent 28928ed commit 5fbf83a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions Readme.md
Expand Up @@ -730,6 +730,8 @@ The supported events are:
| `preAction`, `postAction` | before/after action handler for this command and its nested subcommands | `(thisCommand, actionCommand)` |
| `preSubcommand` | before parsing direct subcommand | `(thisCommand, subcommand)` |

For an overview of the life cycle events see [parsing life cycle and hooks](./docs/parsing-and-hooks.md).

## Automated help

The help information is auto-generated based on the information commander already knows about your program. The default
Expand Down Expand Up @@ -1116,6 +1118,7 @@ There is more information available about:

- [deprecated](./docs/deprecated.md) features still supported for backwards compatibility
- [options taking varying arguments](./docs/options-taking-varying-arguments.md)
- [parsing life cycle and hooks](./docs/parsing-and-hooks.md)

## Support

Expand Down
14 changes: 7 additions & 7 deletions docs/parsing-and-hooks.md
Expand Up @@ -14,10 +14,10 @@ Starting with top-level command (program):

Once reach final (leaf) command:

- check for missing mandatory options
- check for conflicting options
- check for unknown options
- process remaining args as command-arguments
- call `preAction` hook
- call action handler
- call `postAction` hook
- check for missing mandatory options
- check for conflicting options
- check for unknown options
- process remaining args as command-arguments
- call `preAction` hook
- call action handler
- call `postAction` hook

0 comments on commit 5fbf83a

Please sign in to comment.