From ccc0357d5e4ca33542749117675c84859153a08d Mon Sep 17 00:00:00 2001 From: Kb-tay Date: Tue, 14 Nov 2023 02:04:13 +0800 Subject: [PATCH] Update minor issues in DG --- docs/DeveloperGuide.md | 5 +++++ docs/UserGuide.md | 30 +++++++++++++++--------------- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 90feb175ffc..7e3f3632e27 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -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. @@ -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` 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. @@ -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 diff --git a/docs/UserGuide.md b/docs/UserGuide.md index aef80e7cf2a..2585dd2ea29 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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` |
:information_source: **Do note** If the ADDRESS includes any recognized prefixes (leading space + prefix), users should be careful.