Skip to content

Commit 0fd96ee

Browse files
authored
Merge pull request NixOS#5517 from Zimmi48/fix-cli-guideline-typo
Fix some typos in CLI guideline.
2 parents b5cb31e + d589782 commit 0fd96ee

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/manual/src/contributing/cli-guideline.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ love, but if not done perfectly it will annoy users and leave bad impression.
240240
Input to a command is provided via `ARGUMENTS` and `OPTIONS`.
241241
242242
`ARGUMENTS` represent a required input for a function. When choosing to use
243-
`ARGUMENT` over function please be aware of the downsides that come with it:
243+
`ARGUMENTS` over `OPTIONS` please be aware of the downsides that come with it:
244244
245245
- User will need to remember the order of `ARGUMENTS`. This is not a problem if
246246
there is only one `ARGUMENT`.
@@ -253,7 +253,7 @@ developer consider the downsides and choose wisely.
253253
254254
## Naming the `OPTIONS`
255255
256-
Then only naming convention - apart from the ones mentioned in Naming the
256+
The only naming convention - apart from the ones mentioned in Naming the
257257
`COMMANDS` section is how flags are named.
258258
259259
Flags are a type of `OPTION` that represent an option that can be turned ON of
@@ -271,7 +271,7 @@ to improve the discoverability of possible input. A new user will most likely
271271
not know which `ARGUMENTS` and `OPTIONS` are required or which values are
272272
possible for those options.
273273
274-
In cases, the user might not provide the input or they provide wrong input,
274+
In case the user does not provide the input or they provide wrong input,
275275
rather than show the error, prompt a user with an option to find and select
276276
correct input (see examples).
277277

0 commit comments

Comments
 (0)