Merge pull request #341 from RichDom2185/week11/fix-ug-inconsistencies

Fix UG inconsistencies found during peer review
AY2223S1-CS2103T-W16-2 · Oct 27, 2022 · 2479990 · 2479990
2 parents c39687d + 354254b
commit 2479990
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 14 deletions.
diff --git a/docs/_ug/commandSummary/ItemCommands.md b/docs/_ug/commandSummary/ItemCommands.md
@@ -50,18 +50,18 @@
 <!-- ===== CREATE TABLE FORMATTING IN NORMAL+ MARKDOWN ===== -->
 <!-- WE USE :variable: FOR VALUES THAT ARE TO BE SUBSTITUTED -->
 {% capture TABLE %}
-| Action                                                            | Format | Example       |
-|-------------------------------------------------------------------|--------|---------------|
-| Create a new item                                                 | :new:  | :newexample:  |
-| List all items                                                    | :list: | :listexample: |
-| Search for an item                                                | :find: | :findexample: |
-| Sort an item by name, quantity, type, bought date or expiry date. | :sort: | :sortexample: |
-| View information about an item                                    | :view: | :viewexample: |
-| Increase the quantity of an item                                  | :inc:  | :incexample:  |
-| Decrease the quantity of an item                                  | :dec:  | :decexample:  |
-| Update the information of an item                                 | :edit: | :editexample: |
-| Adds a remark to an item                                          | :rmk:  | :rmkexample:  |
-| Delete an item                                                    | :del:  | :delexample:  |
+| Action                                                                            | Format | Example       |
+|-----------------------------------------------------------------------------------|--------|---------------|
+| Create a new item                                                                 | :new:  | :newexample:  |
+| List all items                                                                    | :list: | :listexample: |
+| Search for an item                                                                | :find: | :findexample: |
+| Sort an item by name, quantity, unit, bought date, expiry date, price, or remarks | :sort: | :sortexample: |
+| View information about an item                                                    | :view: | :viewexample: |
+| Increase the quantity of an item                                                  | :inc:  | :incexample:  |
+| Decrease the quantity of an item                                                  | :dec:  | :decexample:  |
+| Update the information of an item                                                 | :edit: | :editexample: |
+| Adds a remark to an item                                                          | :rmk:  | :rmkexample:  |
+| Delete an item                                                                    | :del:  | :delexample:  |
 {% endcapture %}
 
 <!-- ===== RENDER THE ACTUAL TABLE ===== -->

diff --git a/docs/_ug/commands/ItemCommands.md b/docs/_ug/commands/ItemCommands.md
@@ -94,6 +94,7 @@ Item List Box:
 * The order of the `KEYWORDS` do not matter (e.g "rose apple" will match "apple rose").
 * The result will be items in which `ITEM_NAME` contain any one of the `KEYWORDS` provided.
 ```
+
 ```tip
 * You can use the [List Command](#list-all-items-list) to display all items again!
 ```

diff --git a/docs/_ug/placeholders/ITEM_NAME.md b/docs/_ug/placeholders/ITEM_NAME.md
@@ -4,7 +4,7 @@ The ITEM_NAME is the name we use to identify an item.
 ```info
 * ITEM_NAME is a short text with a limit of 200 characters
 * ITEM_NAME can contain alphanumeric characters, spaces, and the following symbols: `?` `'` `.` `"` `[` `]` `{` `}` `(` `)` `+` `^` `$` `*` `-` `,` `:` `;` `@` `!` `#` `%` `&` `_` `=`
-* ITEM_NAME is unique and case-insensitive
+* ITEM_NAME is unique and case-sensitive
 * ITEM_NAME will have leading and trailing spaces trimmed
 * ITEM_NAME cannot be blank
 ```

diff --git a/docs/_ug/placeholders/TAG_NAME.md b/docs/_ug/placeholders/TAG_NAME.md
@@ -4,7 +4,7 @@ The TAG_NAME is the term we use to identify an item.
 ```info
 * TAG_NAME is a short text with a limit of 50 characters
 * TAG_NAME can contain alphanumeric characters, spaces, and the following symbols: `?` `'` `.` `"` `[` `]` `{` `}` `(` `)` `+` `^` `$` `*` `-` `,` `:` `;` `@` `!` `#` `%` `&` `_` `=`
-* TAG_NAME is unique and case-insensitive
+* TAG_NAME is unique and case-sensitive
 * TAG_NAME will have leading and trailing spaces trimmed
 * TAG_NAME cannot be blank
 ```