Merge pull request #538 from Eugenetanwl3881/w13/update-ug-parameter

Clarify the usages of Parameters and Placeholders
AY2223S1-CS2103T-W16-2 · Nov 7, 2022 · c5c0ad0 · c5c0ad0
2 parents 3e8b5e1 + 06e0c7d
commit c5c0ad0
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/_ug/Commands.md b/docs/_ug/Commands.md
@@ -13,7 +13,7 @@ What you should expect to find:
 
 ```note
 * For each command, "Format" indicates the syntax of the command.
-* Square brackets indicates an optional parameter.
+* Square brackets indicates an optional [[ parameter ]].
 * In most commands, if the same parameter is repeated and only one is required, we take the last value provided.
 ```
 

diff --git a/docs/_ug/KeyDefinitions.md b/docs/_ug/KeyDefinitions.md
@@ -36,7 +36,7 @@ FoodRem Tags are unique by name and case-sensitive. This means you cannot add tw
 
 #### Flags
 
-Flags are [[ delimiter:delimiters ]] that enable FoodRem to distinguish different parameters without ambiguity.
+Flags are [[ delimiter:delimiters ]] that enable FoodRem to distinguish different [[ parameter:parameters ]] without ambiguity.
 
 You would put in the corresponding [Placeholder](#placeholders) immediately after each flag.
 
@@ -61,7 +61,7 @@ Please refer to the subsequent [Command Format](#command-format) section to see
 
 #### Placeholders
 
-Placeholders show you what type of parameters you can supply to a command. These follow immediately after a [Flag](#flags).
+Placeholders in this User Guide refers to the UPPER_CASE words that can be replaced by valid user input supplied. These placeholders follow immediately after a [Flag](#flags).
 
 Please refer to the subsequent [Command Format](#command-format) section to see how Flags and Placeholders are used together.
 

diff --git a/docs/_ug/TryingFirstCommand.md b/docs/_ug/TryingFirstCommand.md
@@ -16,7 +16,7 @@ The first word of every command allows FoodRem to distinguish different commands
 * [Flags](#flags) such as `n/` and `qty/` are [[ delimiter:delimiters ]] that enable FoodRem to distinguish different parameters supplied by you without ambiguity
 * [Placeholders](#placeholders) such as `ITEM_NAME` and `QUANTITY` shows you what you should place in each portion of the command
 
-Notice that there is a pair of square brackets `[]` surrounding some parameters like `qty/QUANTITY` in the format. This indicates that the parameter is **optional**. Each of these placeholders have a default value based on the commands. These are documented in the [Commands](#commands) section for each command.
+Notice that there is a pair of square brackets `[]` surrounding some [[ parameter:parameters ]] like `qty/QUANTITY` in the format. This indicates that the parameter is **optional**. Each of these [[ placeholder:placeholders ]] in the [[ parameter:parameters ]] have a default value based on the commands. These are documented in the [Commands](#commands) section for each command.
 
 ```note
 The [Placeholder](#placeholders) section covers the restrictions for respective placeholders. For example, the date format of BOUGHT_DATE, certain characters you cannot use and the limit and precision of numbers.
@@ -82,10 +82,10 @@ Suppose the `INDEX` for potatoes is `1` in the application, the command you woul
 
 You should now have a better understanding of how commands are formatted and used. All commands are consolidated in the [Command Summary](#command-summary).
 
-Here is a checklist you can use before running a command:
+Here is a checklist you can use before running a [[ command ]]:
 
-* [ ] I know the restrictions of the command
+* [ ] I know the restrictions of the command 
 * [ ] I know what [[ parameter:parameters ]] are supplied to the command
 * [ ] I know the [[ flag:flags ]] for each parameter to be supplied
-* [ ] I know the restrictions of each [[ placeholder ]]
+* [ ] I know the restrictions of each parameter
 * [ ] I know the effects of not specifying each optional flag.