Skip to content

Commit d37080e

Browse files
committed
Fix a few known UG bugs reflected by the PE-D
1 The second example of add command is invalid due to 7-digit phone number, change to 8 digit. 2 Change the [m/Module]... into [m/MODULE]… in Edit since the two ellipsis haves lightly different meanings. 3 Change the ellipsis in filter command for the same reason. 4 Mention that the edit of module is also not cumulative, like tags. 5 Mention that the module match in grade command is case-sensitive. 6 Mention that the module grade pair need not to be in order. 7 Mention that the user need to hover over the module a while to view the grade. 8 Add a known issue that certain element in the UI may be hard to see if the size of window is too small. 9 Warn the user that / in names may be recognised as prefix. 10 Add filter command into the command summary.
1 parent 3c5aef8 commit d37080e

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/UserGuide.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Format: `add n/NAME p/PHONE_NUMBER g/GENDER m/MODULE... [t/TAG]…​`
106106

107107
<div markdown="span" class="alert alert-info"> :notebook: **Note:** Field Constraints
108108
- Names should only contain alphabets, hyphens, dots, commas, forward slash and spaces, and be between 1 and 100 characters long.
109+
- Although / is allowed in names, you should use it carefully, input like m/ g/ n/ will still be recognised as prefix and may lead to unexpected behaviour
109110
- Phone numbers should only contain numbers, and be exactly 8 digits long.
110111
- Gender should be either `male` or `female`.
111112
- Module should consist of alphanumeric characters and spaces only, and it should be between 1 and 30 characters long.
@@ -114,7 +115,7 @@ Format: `add n/NAME p/PHONE_NUMBER g/GENDER m/MODULE... [t/TAG]…​`
114115

115116
Examples:
116117
* `add n/John Doe p/98765432 g/male m/Mathematics` : Adds a student named `John Doe` to StoreClass.
117-
* `add n/Betsy Crowe g/female p/1234567 m/Physics m/Chemistry t/OLevels t/new` : Adds a student named `Betsy Crowe` to StoreClass.
118+
* `add n/Betsy Crowe g/female p/12345678 m/Physics m/Chemistry t/OLevels t/new` : Adds a student named `Betsy Crowe` to StoreClass.
118119

119120

120121
### Listing all students : `list`
@@ -127,12 +128,13 @@ Format: `list`
127128

128129
You can edit an existing student in StoreClass.
129130

130-
Format: `edit INDEX [n/NAME] [p/PHONE] [g/GENDER] [m/MODULE]... [t/TAG]…​`
131+
Format: `edit INDEX [n/NAME] [p/PHONE] [g/GENDER] [m/MODULE] [t/TAG]…​`
131132

132133
* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
133134
* At least one of the optional fields must be provided.
134135
* Existing values will be updated to the input values.
135136
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
137+
* Similarly, when editing modules, the existing modules of the person will be removed i.e adding of modules is not cumulative.
136138
* You can remove all the person’s tags by typing `t/` without
137139
specifying any tags after it.
138140

@@ -165,7 +167,7 @@ Examples:
165167

166168
You can filter students who meet all specified conditions.
167169

168-
Format: `filter [n/name] [p/phone] [g/gender] [t/tag]... [m/module]...`
170+
Format: `filter [n/name] [p/phone] [g/gender] [t/tag] [m/module]`
169171
* The filter is case-insensitive. eg `hans` will match `Hans`.
170172
* At least one of the optional fields must be provided.
171173
* Only full words will be matched e.g. `Han` will not match `Hans`, same to all parameter except phone number.
@@ -285,9 +287,10 @@ You can assign a grade to a module that a student is taking.
285287

286288
- Assigns a numerical grade (between 0 and 100) to the module identified by the `INDEX` number shown in the displayed person list.
287289
- `INDEX`: The index number of the student in the displayed person list (must be a positive integer).
288-
- `m/MODULE`: The module code to which the grade is assigned.
290+
- `m/MODULE`: The module code to which the grade is assigned. The module match is case-sensitive.
289291
- `s/GRADE`: The numerical grade (between 0 and 100) to assign to the module.
290-
- You can provide multiple `m/MODULE s/GRADE` pairs to assign grades to multiple modules in a single `grade` command.
292+
- You can provide multiple `m/MODULE s/GRADE` pairs to assign grades to multiple modules in a single `grade` command.
293+
- The `m/MODULE s/GRADE` pairs need not to be in order, see examples for illustration.
291294
- The grade can be any whole number between 0 and 100, inclusive.
292295

293296
<div markdown="span" class="alert alert-info"> :notebook: **Important Note:**
@@ -297,13 +300,14 @@ You can assign a grade to a module that a student is taking.
297300

298301
<div class="alert alert-primary">
299302
<img class="emoji" title=":bulb:" alt=":bulb:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png" height="20" width="20"> <strong>Tip:</strong>
300-
You can hover over each individual module to view the grades for that module.
303+
You can hover over each individual module for a while to view the grades for that module.
301304
</div>
302305

303306
**Examples:**
304307
- `grade 1 m/Physics s/85` : assigns a grade of 85 to Physics for the first student.
305308
- `grade 2 m/Chemistry s/90` : assigns a grade of 90 to Chemistry for the second student.
306309
- `grade 3 m/English s/80 m/Chinese s/85` assigns a grade of 80 to English and 85 to Chinese for the third student.
310+
- `grade 1 m/Math m/Chinese s/100 s/90` will grade the first person's math to 100 and his Chinese to 90.
307311

308312

309313
### Archiving data files `archive`
@@ -447,6 +451,7 @@ Furthermore, certain edits can cause the StoreClass to behave in unexpected ways
447451

448452
1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
449453
2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.
454+
3. **When the UI window is set to a small size** certain element in the UI maybe hard to view. E.g. modules, long names... Hence, we recommend you to use a large screen and a large window size when using our product so that all the fields can be viewed clearly.
450455

451456
--------------------------------------------------------------------------------------------------------------------
452457

@@ -458,7 +463,8 @@ Action | Format, Examples
458463
**Clear** | `clear`
459464
**Delete** | `delete INDEX`<br> e.g., `delete 3`
460465
**Edit** | `edit INDEX [n/NAME] [g/GENDER] [p/PHONE_NUMBER] [m/MODULE] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee`
461-
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
466+
**Find** | `find KEYWORD [MORE_KEYWORDS]…`<br> e.g., `find James Jake`
467+
**Filter** | `filter [n/name] [p/phone] [g/gender] [t/tag]… [m/module]…`<br> e.g., `filter n/James`
462468
**Grade** | `grade INDEX [m/MODULE s/GRADE]`<br> e.g., `grade 1 m/History s/85`
463469
**Undo** | `undo`
464470
**Redo** | `redo`
@@ -467,3 +473,4 @@ Action | Format, Examples
467473
**Archive** | `archive pa/PATH`
468474
**Load** | `load pa/PATH`
469475

476+

0 commit comments

Comments
 (0)