Skip to content

Commit 2a502b9

Browse files
authored
Merge pull request #53 from Sheeepen/update-UG
Add "View students" and "Delete student" to UG commands, update command summary table
2 parents adb74d3 + c967056 commit 2a502b9

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

docs/UserGuide.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Format: `help`
7373

7474
Adds a student with his/her relevant details.
7575

76-
Format: `add student n/NAME c/CONTACT_NUMBER a/HOME_ADDRESS`
76+
Format: `add student n/<NAME> c/<CONTACT_NUMBER> a/<HOME_ADDRESS>`
7777

7878
**Parameters**:
7979
1. Name
@@ -87,9 +87,24 @@ Examples:
8787
* `add student n/John c/81349705 a/Yishun Street 56 Blk 21 #05-07`
8888
* `add student n/Sally c/94149785 a/Woodlands Street 11 Blk 888 #08-08`
8989

90-
### View all students //TODO
90+
### View all students
9191

92-
### Delete a student //TODO
92+
Shows a list of all students.
93+
94+
Format: `view students`
95+
96+
### Delete a student
97+
98+
Deletes an existing student.
99+
100+
Format: `delete <INDEX>`
101+
102+
**Parameters**:
103+
1. Appointment Index
104+
- Numerical characters only
105+
106+
Examples:
107+
* `delete appointment 2`
93108

94109
### Tag student to risk level //TODO
95110

@@ -106,7 +121,7 @@ Format: `add appointment d/<DATETIME_OF_APPOINMENT> n/<NAME_OF_STUDENT>`
106121
- Alphabetical characters only
107122

108123
Examples:
109-
- `add appointment d/2023-12-31 16:30 n/Jon`
124+
- `add appointment d/2023-12-31 16:30 n/Jon`
110125
- `add appointment d/18:30 n/Kiat`
111126

112127
### View all appointments
@@ -119,14 +134,14 @@ Format: `view appointments`
119134

120135
Deletes an existing appointment.
121136

122-
Format: `delete appointment n/INDEX`
137+
Format: `delete appointment <INDEX>`
123138

124139
**Parameters**:
125140
1. Appointment Index
126141
- Numerical characters only
127142

128143
Examples:
129-
* `delete appointment n/2`
144+
* `delete appointment 2`
130145

131146
### Exiting the program : `exit`
132147

@@ -167,13 +182,14 @@ _Details coming soon ..._
167182

168183
## Command summary //TODO: update your respective things
169184

170-
| Action | Format, Examples |
171-
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
172-
| **Add student** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add student n/John c/81349705 a/Yishun Street 56 Blk 21 #05-07` |
173-
| **View Students** | `clear` |
174-
| **Delete student** | `delete INDEX`<br> e.g., `delete 3` |
175-
| **Tag student to risk level** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
176-
| **Add appointment** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
177-
| **View appointments** | `list` |
178-
| **Help** | `help` |
179-
| **Exit** | `exit` |
185+
| Action | Format, Examples |
186+
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
187+
| **Add a student** | `add student n/<NAME> p/<PHONE_NUMBER> a/<HOME_ADDRESS> …​` <br> e.g., `add student n/John c/81349705 a/Yishun Street 56 Blk 21 #05-07` |
188+
| **View all students** | `view students` |
189+
| **Delete a student** | `delete student <INDEX>`<br> e.g., `delete student 3` |
190+
| **Tag student to risk level** | `TODO` |
191+
| **Add an appointment** | `add appointment d/<DATETIME_OF_APPOINMENT> n/<NAME_OF_STUDENT>`<br> e.g., `add appointment d/2023-12-31 16:30 n/Jon` |
192+
| **View appointments** | `view appointments` |
193+
| **Delete an appointment** | `delete appointment <INDEX>`<br> e.g., `delete appointment 3` |
194+
| **Help** | `help` |
195+
| **Exit** | `exit` |

0 commit comments

Comments
 (0)