Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG for Complete and Schedule Command to be clearer #219

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Update UG for Complete and Schedule Command to be clearer #219

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb5d9c9
Update UG for Complete and Schedule Command to be clearer
Kb-Tay Nov 7, 2023
0aa9aaa
Merge branch 'master' into branch-Docs-UpdateUG
Kb-Tay Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<div markdown="span" class="alert alert-primary">: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.
</div>

------------------
### Listing all persons : `list`
Expand Down Expand Up @@ -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.
<div markdown="span" class="alert alert-primary">: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.
</div>

---------------
### Locating persons by name, financial plan, and/or tag : `find`
Expand Down Expand Up @@ -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**.

<div markdown="span" class="alert alert-primary">: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.
</div>

![schedule prompt](images/schedulePrompt.png)

Acceptable Values: Refer to [Argument Summary](#argument-summary).
Expand All @@ -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.

<div markdown="span" class="alert alert-primary">: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.
</div>

Acceptable Values: Refer to [Argument Summary](#argument-summary).

Expand Down