Skip to content

Commit

Permalink
Merge pull request #332 from Jweewee/master
Browse files Browse the repository at this point in the history
Update DG, UG and puml files
  • Loading branch information
yucongkoo authored Nov 13, 2023
2 parents 0a06cd2 + 5effa99 commit bb15339
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
9 changes: 7 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -543,15 +543,19 @@ 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.

<puml src="diagrams/appointment-feature/AppointmentClassDiagram.puml"/>

<div style="page-break-after: always;"></div>

**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.

Expand Down Expand Up @@ -583,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`.

Expand Down
1 change: 1 addition & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,7 @@ After:

* Decrements the customer's completed appointments count at `<index>` by 1.
* Use to reduce the appointment count of customers as needed.
* Does not recover the marked appointment details.

<box type="warning" seamless>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bb15339

Please sign in to comment.