[ts-command-line] Fixes a typo in the README (microsoft#4887)

discordjs · Aug 14, 2024 · 8d69f29 · 8d69f29
1 parent 97c0858
commit 8d69f29
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/common/changes/@rushstack/ts-command-line/patch-1_2024-08-14-11-35.json b/common/changes/@rushstack/ts-command-line/patch-1_2024-08-14-11-35.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/ts-command-line",
+      "comment": "Fix a README typo.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/ts-command-line"
+}
diff --git a/libraries/ts-command-line/README.md b/libraries/ts-command-line/README.md
@@ -45,7 +45,7 @@ Several different kinds of parameters are supported:
 | flag | `--verbose` | `boolean` | Value is `true` if the flag was specified on the command line, `false` otherwise. |
 | integer | `--max-retry 3` | `int` | The argument is an integer number |
 | string | `--title "Hello, world"` | `string` | The argument is a text string. |
-| choice | `--color red` | `string` | The argument is must be a string from a list of allowed choices (similar to an enum). |
+| choice | `--color red` | `string` | The argument must be a string from a list of allowed choices (similar to an enum). |
 | 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. |
 
 Other parameter kinds could be implemented if requested.  That said, keeping your CLI grammar simple and systematic makes it easier for users to learn.