Skip to content

Commit 5fbf83a

Browse files
shadowspawnabetomo
authored andcommitted
Add new documentation to README
1 parent 28928ed commit 5fbf83a

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

Readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,8 @@ The supported events are:
730730
| `preAction`, `postAction` | before/after action handler for this command and its nested subcommands | `(thisCommand, actionCommand)` |
731731
| `preSubcommand` | before parsing direct subcommand | `(thisCommand, subcommand)` |
732732

733+
For an overview of the life cycle events see [parsing life cycle and hooks](./docs/parsing-and-hooks.md).
734+
733735
## Automated help
734736

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

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

11201123
## Support
11211124

docs/parsing-and-hooks.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Starting with top-level command (program):
1414

1515
Once reach final (leaf) command:
1616

17-
- check for missing mandatory options
18-
- check for conflicting options
19-
- check for unknown options
20-
- process remaining args as command-arguments
21-
- call `preAction` hook
22-
- call action handler
23-
- call `postAction` hook
17+
- check for missing mandatory options
18+
- check for conflicting options
19+
- check for unknown options
20+
- process remaining args as command-arguments
21+
- call `preAction` hook
22+
- call action handler
23+
- call `postAction` hook

0 commit comments

Comments
 (0)