diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 02c903b80ec..5a137f6ffb7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -178,7 +178,9 @@ Appointment: No Appointment made!; Financial Plans: [Financial Plan C]; Tags: [80yo]` -Do note that it is possible to add a client's contact with multiple tags by duplicating the `t/` prefix. The same can be done with for financial plans with the `fp/` prefix. +
:information_source: +**Do note** that it is possible to add a client's contact with multiple tags by duplicating the `t/` prefix. The same can be done with for financial plans with the `fp/` prefix. +
------------------ ### Listing all persons : `list` @@ -228,7 +230,9 @@ Tags:` ![result for 'edit 4 n/john doe a/23 woodlands ave 123'](images/editUi.png) -Do note that it is possible to edit a client's contact such that the contact has multiple tags by duplicating the `t/` prefix. The same can be done with for financial plans with the `fp/` prefix. +
:information_source: +**Do note** that it is possible to add a client's contact with multiple tags by duplicating the `t/` prefix. The same can be done with for financial plans with the `fp/` prefix. +
--------------- ### Locating persons by name, financial plan, and/or tag : `find` @@ -309,8 +313,13 @@ Schedules an appointment for a client using an index followed by the appointment Format: `schedule INDEX ap/APPOINTMENT_NAME d/APPOINTMENT_DATE_TIME` - Schedules appointment with the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. -- Both appointment name and date must be provided. -- If there is an existing appointment with the person when command is executed, you can replace it with a new appointment by clicking confirm when prompt is given. +- **Both appointment name and date-time** must be provided. +- Upon successful execution of the command, the scheduled appointment details will be updated in the **Contacts list**. The appointment details will also be updated in the **Appointments list**. + +
:information_source: +If there is an existing appointment with the person when command is executed, you can replace it with a new appointment by **clicking confirm** or **pressing the enter key** when prompt is given. +
+ ![schedule prompt](images/schedulePrompt.png) Acceptable Values: Refer to [Argument Summary](#argument-summary). @@ -325,12 +334,17 @@ Successful Output: `Appointment updated!` ---------- ### Completing an Appointment : `complete` -Completes an appointment with clients. User can input an index to complete an appointment with a specific client. User can also input a specific date to complete all appointments with the matching date. +Completes an appointment either with the person at the specified `INDEX` or complete all appointments with matching `APPOINTMENT_DATE`. Format: `complete [INDEX] [d/APPOINTMENT_DATE]` -- Completes appointment with the person at the specified INDEX. The index refers to the index number shown in the displayed person list. -- **Either an index or appointment date must be provided** for command to execute. +- **Either an index or appointment date must be provided** for command to execute. +- If user inputs an `INDEX`, command will complete appointment with the person at the specified `INDEX`. The index refers to the index number shown in **Contacts list**. +- If user inputs an `APPOINTMENT_DATE`, command will complete all appointments in address book that have a date matching the one input by user. This is to allow the user to clear all his/her appointments finished throughout the entire day quickly. + +
:information_source: +**Note** that an appointment's date is considered to be a match with user's input `APPOINTMENT_DATE` if the year, month and day are the same. Time of the appointment does not matter in this command. +
Acceptable Values: Refer to [Argument Summary](#argument-summary).