Skip to content

Commit 15fcc4a

Browse files
authored
Merge pull request #252 from Alteqa/branch-fixDGbugs
Update DG
2 parents 7bfb64a + c766ed4 commit 15fcc4a

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

docs/DeveloperGuide.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,8 @@ The sequence diagram below demonstrates the command execution steps for `execute
254254
This is the sequence of command execution for `execute` in `AddPatientCommand`, however `AddDoctorCommand` and `AddAppointmentCommand` follow similar design patterns within the execute command.
255255
Add command execution sequence:
256256
* Step 1. The `execute` method of the `AddPatientCommand` is called.
257-
* Step 2. The method calls the `hasPerson` method of `Model` to check if there are any duplicate patients and throws an exception if there is.
258-
* If there is a duplicate person, the method calls the `log` method of `logger` to log the incident.
257+
* Step 2. The method calls the `hasPerson` method of `Model` to check if there are any duplicate patients.
258+
* If there is a duplicate person, the method throws `CommandException` and calls the `log` method of `logger` to log the incident.
259259
* Step 3. The `addPerson` method of `Model` is then called and the control is passed back to the `execute` method.
260260
* Step 4. The `log` method of `logger` is then called to log the successful command execution.
261261
* Step 5. A new `CommandResult` object with the success message is then created and returned by `execute`.
@@ -313,7 +313,7 @@ This command is implemented through the `DeleteCommand` class which extends the
313313

314314
* Step 1. The `execute` method of the `DeleteCommand` is called.
315315
* Step 2. The `getFilteredPersonList` method of `Model` is called and finds its length.
316-
* Step 3. The `getZeroBased` method of `Index` is called to convert the provided index to its zero-based equivilent.
316+
* Step 3. The `getZeroBased` method of `Index` is called to convert the provided index to its zero-based equivalent.
317317
* Step 4. The provided index is checked against the length of the current list of people.
318318
* If the provided index is out of bounds, a `CommandException` is thrown.
319319
* Step 4. The `deletePerson` method of `Model` is called to remove the designated person from the list of people.
@@ -334,7 +334,6 @@ Why is this implemented this way?
334334
6. This results in a cleaner `Appointments` panel, and saves the user from the hassle of needing to delete unwanted `Appointment` entries one by one.
335335

336336

337-
338337
### Add a `Appointment`
339338

340339
Adds a new `Appointment` entry by indicating the `patientNric`, `doctorNric`, and an `appointmentDateTime`.
@@ -578,14 +577,6 @@ The following activity diagram summarizes what happens when a user executes a ne
578577
* Cons: We must ensure that the implementation of each individual command are correct.
579578

580579

581-
_{more aspects and alternatives to be added}_
582-
583-
584-
### \[Proposed\] Data archiving
585-
586-
587-
_{Explain here how the data archiving feature will be implemented}_
588-
589580
## Planned Enhancements
590581

591582
The MediCLI development team (consisting of 5 members) acknowledges the presense of known feature flaws in our system.

0 commit comments

Comments
 (0)