diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 638dfc45217..611830d28be 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -168,7 +168,7 @@ Grades + the grade is a value from 0 to 100, representing the percentage gotten in the test rounded to the nearest whole number * are an optional parameter -Grades can be added and edited with the add and edit command with the prefix `g/`. +Grades can be added and edited with the add and edit command with the prefix `g/` and `!g` respectively. Given below are example usages scenario of how adding grades behaves. * The user executes `add n/David … g/ca1: 100` command to add a new student with one grade, with the test name being `ca1` and the score attained `100` @@ -188,7 +188,7 @@ Timeslots + For example, 'Saturday 4pm-6pm', 'Tuesday 2:30pm-4:30pm' * are an optional parameter -Timeslots can be added and edited with the add and edit command with the prefix `t/`. +Timeslots can be added and edited with the add and edit command with the prefix `t/` and `!t` respectively. Given below are example usages scenario of how adding timeslots behaves. * The user executes `add n/David … t/Saturday 4pm-6pm` command to add a new student with one timeslot on Saturdays 4pm-6pm @@ -461,11 +461,11 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case ends. * 2e. The given timeslots are invalid. - * 2d1. System shows an error message. + * 2e1. System shows an error message. Use case ends. -* 2e. The student exists in the database already. - * 2e1. System shows an error message. +* 2f. The student exists in the database already. + * 2f1. System shows an error message. Use case ends. @@ -475,7 +475,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 1. User requests to list students. 2. System displays the list of students. 3. User requests to update a specific student information. -4. System updates the student information. +4. System displays the specific current data of the student. +5. User update the current data of the student. +6. System updates the student information. Use case ends. @@ -485,22 +487,42 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 2a1. System shows an error message. Use case ends. -* 3a. The given phone number is invalid. +* 3a. The given index is invalid. * 3a1. System shows an error message. Use case ends. -* 3b. The given email is invalid. +* 3b. The given variable is invalid. * 3b1. System shows an error message. Use case ends. -* 3c. The given grades are invalid. +* 3c. The given variable is more than 1. * 3c1. System shows an error message. Use case ends. -* 3d. The given index is invalid. +* 3d. The given variable is less than 1. * 3d1. System shows an error message. Use case ends. +* 5a. The given phone number is invalid. + * 5a1. System shows an error message. + + Use case ends. +* 5b. The given email is invalid. + * 5b1. System shows an error message. + + Use case ends. +* 5c. The given grades are invalid. + * 5c1. System shows an error message. + + Use case ends. +* 5d. The given timeslots are invalid. + * 5d1. System shows an error message. + + Use case ends. +* 5e. The student exists in the database already. + * 5e1. System shows an error message. + + Use case ends. **Use case:** UC04 - Delete a student.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 33c1dd6e988..d4eec194e73 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -90,7 +90,7 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TIMESLOTS]…​ [g/GRAD Examples: * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` -* `add n/Betsy Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567 t/Saturday 5pm-7pm g/ca1: 2` +* `add n/Betsy Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567 t/Saturday 5pm-7pm g/ca1: 2 g/ca2: 80` ### Listing all students : `list` @@ -105,13 +105,16 @@ Edits an existing student in the TutorTrack. Format: `edit INDEX !n | !p | !e | !a | !t | !g` * Edits the student at the specified `INDEX`. The index refers to the index number shown in the displayed student list. The index **must be a positive integer** 1, 2, 3, …​ -* Only one of the variable fields must be provided. +* **Only one** of the `VARIABLE` field must be provided. * Existing values will be updated to the input values. -* Adding and modifying multiple tags and grades are allowed, i.e. they will not be overwritten. +* Allow modifications (add/edit/delete) in timeslots and grades, i.e. they will not be overwritten. + * Add: Separate using commas, i.e. `edit 2 grade: ca1: 2, ca2: 80` to `edit 2 grade: ca1: 2, ca2: 80, ca3: 66` + * Edit: Make changes to the current data, i.e. `edit 2 timeslot: Saturday 5pm-7pm` to `edit 2 timeslot: Monday 2pm-3pm` + * Delete: Remove the data, i.e. `edit 2 grade: ca1: 2, ca2: 80, ca3: 66` to `edit 2 grade: ca1: 2, ca3: 66` Examples: -* `edit 1 !p` will display `edit 1 phone: {previous phone number}`, prompting user to make changes to the phone number of the 1st student. -* `edit 2 !g` will display `edit 2 grade: {previous grades}`, prompting user to add (single or multiple) additional grades or modify current grades of the 2nd student. +* `edit 1 !p` will display `edit 1 phone: {current phone number}`, prompting user to make changes to the phone number of the 1st student. +* `edit 2 !g` will display `edit 2 grade: {current grades}`, prompting user to modify (add/edit/delete) grades of the 2nd student. ### Locating students by name: `find`