Skip to content

Commit

Permalink
Merge pull request #337 from Kb-Tay/branch-Docs-UpdateSeqDiagram
Browse files Browse the repository at this point in the history 
Update minor issues in DG
  • Loading branch information
@sopa301
sopa301 authored Nov 13, 2023
2 parents c737575 + ccc0357 commit 28487aa
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 15 deletions.
5 changes: 5 additions & 0 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ Alternative 2: Abstract CommandResult to get a successfulExecutionResult and a P

### Complete Feature

#### Implementation Overview

The **Complete** feature is facilitated by the `CompleteCommand` and `CompleteCommandParser`. The
`CompleteCommandParser` creates a `CompleteByIndex` or `CompleteByDate` object depending on the user's input. Both `CompleteByIndex` and `CompleteByDate` extends `CompleteCommand` as illustrated in the class diagram below.

Expand Down Expand Up @@ -469,6 +471,8 @@ each command

### Appointment List Feature

#### Implementation Overview

The appointment list is facilitated by `ModelManager`. It extends `Model` and stores an additional `SortedList<Appointment>` object that represents all existing appointments.
The `setAppointmentList()` method checks against `filteredPersons` to look for updates regarding existing `Appointment` objects. The `setAppointmentList()` method is called whenever there is a command that can potentially change the data stored, to ensure that the state of the appointment list is as updated as possible.

Expand Down Expand Up @@ -780,6 +784,7 @@ initialised with the focus on the `confirm` button. This makes it possible for a
twice and wipe the contact book anyway, bypassing the defence mechanism entirely. We plan to make the command more
resistant to mistakes by having the user key in a specific phrase, or to initialise the window with the focus on the
`cancel` button instead.
7. The `schedule` and `complete` command current uses the same `d/` prefix but the format for the arguments is different for both. We plan to update add a new `dt/` prefix to represent date-time arguments for `schedule` command to prevent confusion for the users.


### Glossary
Expand Down
30 changes: 15 additions & 15 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,21 +161,21 @@ Below is a table summarising common arguments used in `add`, `edit`, `find`, `sc
to view the arguments' prefix, and their acceptable values. Unless specified, having only space characters i.e. an empty
value, is not an acceptable value and will result in a warning.

| Prefix | Argument | Acceptable Values |
|--------|-----------------------|---------------------------------------------------------------------------------------------------------------------------|
| - | INDEX | Number (1 to current size of the contact book) |
| `n/` | NAME | Alphabets, numbers, and space characters only |
| `p/` | PHONE_NUMBER | Numbers only and at least 3 digits long |
| `e/` | EMAIL | Alphabets, numbers, and symbols only in a valid email format |
| `a/` | ADDRESS | Alphabets, numbers, space characters and symbols only |
| `nk/` | NEXT_KIN | Alphabets, numbers, and space characters only |
| `nkp/` | NEXT_KIN_PHONE | Numbers only and at least 3 digits long |
| `fp/` | FINANCIAL_PLAN | Alphabets, numbers, and space characters only. Empty value is accepted when using [Edit](#editing-a-client-contact--edit) |
| `t/` | TAG | Alphabets and numbers only. Empty value is accepted when using [Edit](#editing-a-client-contact--edit) |
| `ap/` | APPOINTMENT_NAME | Alphabets, numbers, and space characters only |
| `d/` | APPOINTMENT_DATE | Format: dd-MM-yyyy (e.g., 31-12-2023) |
| `d/` | APPOINTMENT_DATE_TIME | Format: dd-MM-yyyy HH:mm (e.g., 31-12-2023 14:30) |
| - | KEYWORD | `name` or `appointment` |
| Prefix | Argument | Acceptable Values |
|--------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------|
| - | INDEX | Number (1 to current size of the contact book) |
| `n/` | NAME | Alphabets, numbers, and space characters only |
| `p/` | PHONE_NUMBER | Numbers only and at least 3 digits long |
| `e/` | EMAIL | Alphabets, numbers, and symbols only in a valid email format |
| `a/` | ADDRESS | Alphabets, numbers, space characters and symbols only |
| `nk/` | NEXT_KIN | Alphabets, numbers, and space characters only |
| `nkp/` | NEXT_KIN_PHONE | Numbers only and at least 3 digits long |
| `fp/` | FINANCIAL_PLAN | Alphabets, numbers, and space characters only. Empty value is accepted only when using [Edit](#editing-a-client-contact--edit) |
| `t/` | TAG | Alphabets and numbers only. Empty value is accepted only when using [Edit](#editing-a-client-contact--edit) |
| `ap/` | APPOINTMENT_NAME | Alphabets, numbers, and space characters only |
| `d/` | APPOINTMENT_DATE | Format: dd-MM-yyyy (e.g., 31-12-2023) |
| `d/` | APPOINTMENT_DATE_TIME | Format: dd-MM-yyyy HH:mm (e.g., 31-12-2023 14:30) |
| - | KEYWORD | `name` or `appointment` |

<div markdown="span" class="alert alert-primary">:information_source:
**Do note** If the ADDRESS includes any recognized prefixes (leading space + prefix), users should be careful.
Expand Down

0 comments on commit 28487aa

Please sign in to comment.