aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorThéo Zimmermann <theo.zimmermann@inria.fr>2021-11-08 08:24:15 +0100
committerThéo Zimmermann <theo.zimmermann@inria.fr>2021-11-08 08:24:15 +0100
commitd589782fb0b8e73f562792ba9d02339e32cb2d84 (patch)
tree3af1f673f9ae5d89b919456e43240f9996c247d2 /doc/manual
parent3d6ee223d6fff37610790dfbda1329f05bfc4058 (diff)
Fix some typos in CLI guideline.
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/src/contributing/cli-guideline.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/manual/src/contributing/cli-guideline.md b/doc/manual/src/contributing/cli-guideline.md
index 69bc45691..258f090fb 100644
--- a/doc/manual/src/contributing/cli-guideline.md
+++ b/doc/manual/src/contributing/cli-guideline.md
@@ -240,7 +240,7 @@ love, but if not done perfectly it will annoy users and leave bad impression.
Input to a command is provided via `ARGUMENTS` and `OPTIONS`.
`ARGUMENTS` represent a required input for a function. When choosing to use
-`ARGUMENT` over function please be aware of the downsides that come with it:
+`ARGUMENTS` over `OPTIONS` please be aware of the downsides that come with it:
- User will need to remember the order of `ARGUMENTS`. This is not a problem if
there is only one `ARGUMENT`.
@@ -253,7 +253,7 @@ developer consider the downsides and choose wisely.
## Naming the `OPTIONS`
-Then only naming convention - apart from the ones mentioned in Naming the
+The only naming convention - apart from the ones mentioned in Naming the
`COMMANDS` section is how flags are named.
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
not know which `ARGUMENTS` and `OPTIONS` are required or which values are
possible for those options.
-In cases, the user might not provide the input or they provide wrong input,
+In case the user does not provide the input or they provide wrong input,
rather than show the error, prompt a user with an option to find and select
correct input (see examples).