From b7978a0d363641b784a0a9deada0b3c4d48843da Mon Sep 17 00:00:00 2001 From: Jweewee Date: Mon, 13 Nov 2023 20:44:58 +0800 Subject: [PATCH 1/2] Update DG, UG and puml files --- docs/DeveloperGuide.md | 6 ++++-- docs/UserGuide.md | 1 + .../ExecutedAppointmentSequenceDiagram.puml | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 1c8c0ae8c9c..7428a025c4d 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -543,14 +543,16 @@ with a customer by editing the details of the `Appointment` and `AppointmentCoun This class is used to represent the appointment that each `Person` has, containing data: * `date` of the appointment in `dd-MMM-yyyy` format as a `String` * `time` of the appointment in `HHmm` format as a `String` -* `venue` of the appointment as a `String` lesser than or equals to 30 characters -By default, each `Person` has an empty default appointment with an empty `Date`. +* `venue` of the appointment as a `String` lesser than or equals to 30 characters. + +By default, each `Person` has an empty default appointment.
**Implementing `AppointmentCommand`** + `AppointmentCommand` executes its command on the Model, updating the Model accordingly to reflect the changes made by the command on the Model. Note that an `AppointmentCommand` is **non-executable** if the index is not in range or the person has an existing appointment. The sequence diagram below illustrates the interactions of `AppointmentCommand#execute(Model model)`, taking `execute(m)` call to the `AppointmentCommand` as an example. Note that the **reference frames have been omitted** as the operations performed are trivial. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 329a5e4415d..50e05cdf448 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -555,6 +555,7 @@ After: * Decrements the customer's completed appointments count at `` by 1. * Use to reduce the appointment count of customers as needed. +* Does not recover the marked appointment details. diff --git a/docs/diagrams/appointment-feature/ExecutedAppointmentSequenceDiagram.puml b/docs/diagrams/appointment-feature/ExecutedAppointmentSequenceDiagram.puml index ebeac632a52..e336ed9c9f6 100644 --- a/docs/diagrams/appointment-feature/ExecutedAppointmentSequenceDiagram.puml +++ b/docs/diagrams/appointment-feature/ExecutedAppointmentSequenceDiagram.puml @@ -19,7 +19,7 @@ AppointmentCommand -> AppointmentCommand: verifyCommandExecutable(m) ref over AppointmentCommand, Model: retrieve information required\n(i.e. personToEdit, appointment) ||| -AppointmentCommand -> PersonClass: createPersonWithEditedAppointment(personToUpdate, appointment) +AppointmentCommand -> PersonClass: createPersonWithEditedAppointment(personToEdit, appointment) activate PersonClass create Person From 5effa998f36795d386d619b2797deb1642b74c6d Mon Sep 17 00:00:00 2001 From: Jweewee Date: Mon, 13 Nov 2023 20:56:37 +0800 Subject: [PATCH 2/2] Update DG --- docs/DeveloperGuide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 7428a025c4d..a8bacf18ba9 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -554,6 +554,8 @@ By default, each `Person` has an empty default appointment. **Implementing `AppointmentCommand`** `AppointmentCommand` executes its command on the Model, updating the Model accordingly to reflect the changes made by the command on the Model. Note that an `AppointmentCommand` is **non-executable** if the index is not in range or the person has an existing appointment. +Note that an `AppointmentCommand` is **non-executable** if there is an **existing appointment**. + The sequence diagram below illustrates the interactions of `AppointmentCommand#execute(Model model)`, taking `execute(m)` call to the `AppointmentCommand` as an example. Note that the **reference frames have been omitted** as the operations performed are trivial. @@ -585,6 +587,7 @@ The sequence diagram below illustrates the interactions of `AppointmentCommandPa `AppointmentCommandParser` will extract out the relevant information and create the corresponding `AppointmentCommand` which will be executed by other `Logic` components. + The sequence diagram below shows the interactions between `Logic` components when the user inputs the command `addappt 1 d/2025-12-12 t/12:55 v/Clementi Mall`.