diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1935093f005..8b047530630 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -76,15 +76,15 @@ Format: `help` Adds a person to the contacts. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​` +Format: `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​`
:bulb: **Tip:** -A person can have any number of tags (including 0) +A person can have any number of tags and availabilities (including 0)
Examples: * `add n/John Doe p/98765432 e/johnd@example.com v/John street, block 123, #01-01 m/CS2103` -* `add n/Betsy Crowe t/friend m/CS2103T e/betsycrowe@example.com v/Newgate Prison p/1234567 t/criminal` +* `add n/Betsy Crowe t/friend m/CS2103T e/betsycrowe@example.com v/Newgate Prison p/1234567 t/criminal a/monday a/wednesday` ### Listing all persons : `list` @@ -96,7 +96,7 @@ Format: `list` Edits an existing person in the contacts. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​` +Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​` * 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, …​ * At least one of the optional fields must be provided. @@ -104,6 +104,9 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]… * When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. * You can remove all the person’s tags by typing `t/` without specifying any tags after it. +* When editing availabilities, the existing availabilites of the person will be removed i.e adding of availabilities is not cumulative. +* You can remove all the person’s availabilities by typing `a/` without + specifying any availabilities after it. Examples: * `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. @@ -189,10 +192,10 @@ _Details coming soon ..._ Action | Format, Examples --------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com v/123, Clementi Rd, 1234665 m/CS2103 t/friend t/colleague` +**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com v/123, Clementi Rd, 1234665 m/CS2103 t/friend t/colleague a/monday` **Clear** | `clear` **Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` +**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` **List** | `list` **Help** | `help`