Merge pull request #271 from AY2324S1-CS2103T-F08-0/fix-ug-bugs

Fix ug bugs
AY2324S1-CS2103T-F08-0 · Nov 13, 2023 · 6320e7a · 6320e7a
2 parents c71204b + e74c6aa
commit 6320e7a
Showing 1 changed file with 13 additions and 3 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -194,6 +194,13 @@ add --name NAME [--role ROLE1, ...]  [--contact CONTACT1, ...]
 | `--contact` | The contact details of the person you are adding |
 | `--course`  | The course the person is taking                  |
 
+<box type="info">
+    <md>
+        While no space is required between the specifier and the following field (in other words, `--courseCS2100` is equivalent to `--course CS2100`), it is recommended that a space be added for readability.
+    </md>
+</box>
+
+
 <div style="page-break-after: always;"></div>
 
 ### Help page: `help`
@@ -461,6 +468,7 @@ Favourite the persons in the user’s current person list.
 ###### ACCEPTABLE VALUES:
 `INDEX`: Any number representing a positive integer (i.e. 1, 2, 3, …),
 less than or equal to the number of persons the user currently has.
+The maximum `INDEX` allowed is `2 147 483 647`.
 
 > 📝Note:
 >
@@ -506,6 +514,7 @@ Un-favourite a favourite person
 ###### ACCEPTABLE VALUES:
 `INDEX`: Any number representing a positive integer (i.e. 1, 2, 3, …),
 less than or equal to the number of persons the user currently has.
+The maximum `INDEX` allowed is `2 147 483 647`.
 
 > 📝Note:
 >
@@ -587,6 +596,7 @@ Delete the specific person based on the index allocated to the person.
 ###### ACCEPTABLE VALUES:
 `INDEX`: Any number representing a positive integer (i.e. 1, 2, 3, …),
 less than or equal to the number of persons the user currently has.
+The maximum `INDEX` allowed is `2 147 483 647`.
 
 ###### EXPECTED OUTPUT ON SUCCESS:
 ```
@@ -659,7 +669,7 @@ Search for persons using role.
 
 Output persons which match the given role.
 
-> Note: The input name is NOT case-sensitive.
+> Note: The input role is NOT case-sensitive. In other words, `searchrole ta` is equivalent to `searchrole TA`, which will find all `TA` entries.
 
 ###### FORMAT:
 `searchrole ROLE`
@@ -705,7 +715,7 @@ Search for persons using course.
 
 Output persons which match the given course.
 
-> Note: The input course is NOT case-sensitive.
+> Note: The input course is NOT case-sensitive. In other words, `searchcourse cs1101` is equivalent to `searchcourse CS1101`, which will match both `CS1101` and `cs1101`.
 
 ###### FORMAT:
 `searchcourse COURSECODE`
@@ -741,7 +751,7 @@ Search for persons using tutorial class.
 
 Output persons which match the given tutorial class.
 
-> Note: The input tutorial is NOT case-sensitive.
+> Note: The input tutorial is NOT case-sensitive. In other words, `searchtutorial cs2100/t03` is equivalent to `searchtutorial CS2100/T03` which will match both `cs2100/t03` as well as `CS2100/T03`.
 
 ###### FORMAT:
 `searchtutorial TUTORIAL`