Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix minor problems in Developer Guide #204

Merged
merged 3 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The sequence diagram below illustrates the interactions within the `Logic` compo

![Interactions Inside the Logic Component for the `delete 1` Command](images/DeleteSequenceDiagram.png)

<b markdown="span" class="alert alert-info">:information_source: <b>Note:</b> The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.
<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.
</div>

How the `Logic` component works:
Expand Down Expand Up @@ -226,7 +226,7 @@ Given below is an example usage scenario and how the edit patient feature behave
**Step 3.** A new `EditPersonDescriptor` object is created with the new ward details.
A new `EditCommand` instance will be created with the index of the patient to be edited and the new `EditPersonDescriptor` object.

**Step 4.** The `EditCommand` instace is returned to the `LogicManager` and `execute` is called.
**Step 4.** The `EditCommand` instance is returned to the `LogicManager` and `execute` is called.

**Step 5.** The `EditCommand` instance calls `Model#setPerson(Person, Person)` to edit the patient's details.
The patient specified will have its ward updated to the new ward specified.
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/AddSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ destroy AddCommandParser
AddressBookParser --> LogicManager
deactivate AddressBookParser

LogicManager -> AddCommand : execute(model)
LogicManager -> AddCommand : execute(m)
activate AddCommand
'add parameters of add command here; replace '1''
AddCommand -> Model : addPerson(person)
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/DeleteActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ start
: User enters delete command;
: LogicManager executes user input;
: AddressBookParser parses delete command;
: DeleteCommandParser parses the arguments provided in add command;
: DeleteCommandParser parses the arguments provided in add command;
if() then ([valid index])
: AddressBookManager deletes the contact;
else ([else])
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Person *--> "1" Ic
Person *--> "1" AdmissionDate
Person *--> "1" Dob
Person *--> "1" Ward
Person *--> "1" Remark
Person *--> "0..1" Remark
Person *--> "*" Tag

Person -[hidden]up--> I
Expand Down
Binary file modified docs/images/AddSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/DeleteActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading