diff --git a/docs/UserGuide.md b/docs/UserGuide.md index e408d14c17a..a66b1fe46ff 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -27,7 +27,7 @@ TutorsGo is a **desktop app for managing contacts, optimized for use via a Comma * `list` : Lists all contacts. - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 s/English d/2024-02-03 1800` : Adds a contact named `John Doe` to the Address Book. + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 s/English at/present pa/paid d/2024-02-03 1800` : Adds a contact named `John Doe` to the Address Book. * `delete 3` : Deletes the 3rd contact shown in the current list. @@ -57,7 +57,7 @@ TutorsGo is a **desktop app for managing contacts, optimized for use via a Comma * Parameters can be in any order.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `view` `list`, `exit` and `clear`) will be ignored.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `view`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. @@ -76,13 +76,15 @@ Format: `help` Adds a student to the address book. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GRADE] [s/SUBJECT] [d/DATETIME]…​ [t/TAG]…​` +Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GRADE] [s/SUBJECT] [at/ATTENDANCE] [pa/PAYMENT] [d/DATETIME]…​ [t/TAG]…​`
:bulb: **Tip:** A student can have any number of tags (including 0)
* Grade follows NUS grading system. (i.e. [A+, A, A-, B+, B, B-, C+, C, D+, D, F]) -* DateTime should be in yyyy-mm-dd hhmm +* DateTime should be in yyyy-mm-dd hhmm and a valid date +* Attendance should be present or absent +* Payment should be paid or not paid Examples: * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 g/B+ s/Mathematics d/2024-02-03 1800` @@ -98,7 +100,7 @@ Format: `list` Edits an existing student in the address book. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GRADE] [s/SUBJECT] [d/DATETIME]…​ [t/TAG]…​` +Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GRADE] [s/SUBJECT] [at/ATTENDANCE] [pa/PAYMENT] [d/DATETIME]…​ [t/TAG]…​` * 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, …​ * At least one of the optional fields must be provided. @@ -106,6 +108,8 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GRADE] [s/SUBJEC * When editing tags, the existing tags of the student will be removed i.e adding of tags is not cumulative. * You can remove all the student’s tags by typing `t/` without specifying any tags after it. +* * You can remove all the student’s datetime by typing `d/` without + specifying any datetime after it. Examples: * `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st student to be `91234567` and `johndoe@example.com` respectively. @@ -241,4 +245,5 @@ Action | Format, Examples **View Schedule**|`view` **history**|`history` **List** | `list` -**Help** | `help` +**Help** | `help` +**Exit** | `exit`