Skip to content

Commit 4ec1421

Browse files
committed
chore(readme): fix typos
1 parent bad391d commit 4ec1421

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1489,18 +1489,18 @@ commands: Map(6) {
14891489
14901490
Each of these six commands is actually _three_ programs:
14911491
1492-
1. The **effector** (`programs.effector`) programs is responsible for
1492+
1. The **effector** (`programs.effector`) programs are responsible for
14931493
second-pass arguments parsing and comprehensive validation, executing each
14941494
command's actual [`handler`][8] function, generating specific help text
14951495
during errors, and ensuring the final parse result bubbles up to the router
14961496
program.
14971497
1498-
2. The **helper** (`programs.helper`) programs is responsible for generating
1498+
2. The **helper** (`programs.helper`) programs are responsible for generating
14991499
generic help text as well as first-pass arguments parsing and initial
15001500
validation. Said parse result is used as the `argv` third parameter passed to
15011501
the [`builder`][8] functions of effectors.
15021502
1503-
3. The **router** (`programs.router`) programs is responsible for proxying
1503+
3. The **router** (`programs.router`) programs are responsible for proxying
15041504
control to other routers and to helpers, and for ensuring exceptions and
15051505
final parse results bubble up to the root Black Flag execution context
15061506
([`PreExecutionContext::execute`][12]) for handling.
@@ -1652,7 +1652,7 @@ What follows is a flow diagram illustrating Black Flag's execution flow using
16521652
the `myctl` example from the previous sections.
16531653
16541654
```text
1655-
`myctl --version`
1655+
`myctl --verbose`
16561656
┌───────────────────────────────────┐
16571657
2
16581658
│ ┌─────►┌───────────┐ │
@@ -1734,9 +1734,9 @@ Suppose the user executes `myctl --verbose`.<sup>🡒1</sup> Black Flag (using
17341734
`runProgram`) calls your configuration hooks, discovers all available commands,
17351735
and creates three programs per discovered command: the "router", "helper", and
17361736
"effector". If there was an error during discovery/configuration or hook
1737-
execution, the error handling hook would execute before the process exited with
1738-
the appropriate code.<sup>1🡒R1</sup> This is how all errors that bubble up are
1739-
handled. Otherwise, Black Flag calls the root
1737+
execution, an internal error handling routine would execute before the process
1738+
exited with the appropriate code.<sup>1🡒R1</sup> This is how all errors that
1739+
bubble up are handled. Otherwise, Black Flag calls the root
17401740
`RouterProgram::parseAsync`.<sup>1🡒2</sup> The router detects that the given
17411741
arguments refer to the current command and so calls
17421742
`HelperProgram::parseAsync`.<sup>2🡒3B</sup> If the helper throws (e.g. due to a

0 commit comments

Comments
 (0)