Skip to content

Commit 8d69f29

Browse files
[ts-command-line] Fixes a typo in the README (#4887)
1 parent 97c0858 commit 8d69f29

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@rushstack/ts-command-line",
5+
"comment": "Fix a README typo.",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@rushstack/ts-command-line"
10+
}

libraries/ts-command-line/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Several different kinds of parameters are supported:
4545
| flag | `--verbose` | `boolean` | Value is `true` if the flag was specified on the command line, `false` otherwise. |
4646
| integer | `--max-retry 3` | `int` | The argument is an integer number |
4747
| string | `--title "Hello, world"` | `string` | The argument is a text string. |
48-
| choice | `--color red` | `string` | The argument is must be a string from a list of allowed choices (similar to an enum). |
48+
| choice | `--color red` | `string` | The argument must be a string from a list of allowed choices (similar to an enum). |
4949
| string list | `-o file1.txt -o file2.txt` | `string[]` | The argument is a text string. The parameter can be specified multiple times to build a list. |
5050

5151
Other parameter kinds could be implemented if requested. That said, keeping your CLI grammar simple and systematic makes it easier for users to learn.

0 commit comments

Comments
 (0)