Merge pull request #294 from geoffong11/update-UG

Update schedulediagram to make sure it's larger in pdf
AY2324S1-CS2103-F13-1 · Nov 12, 2023 · 57ccc4a · 57ccc4a
2 parents 89f1fee + 7d4aa6b
commit 57ccc4a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -218,7 +218,8 @@ object, where it is used construct a `ScheduleCommand` object.
 Through `ScheduleCommand#execute()`, the `scheduleDescriptor` is then used to create a `Person` object with the added or edited schedule and schedule name.
 Through `model#setPerson()`, the `Person` object created then replaces the original `Person` object in the list.
 
-The sequence diagram below shows the interaction between Logic and Model components after the API call `execute("schedule 1 i/2023-12-27-07-00 a/Seminar")`
+The sequence diagram below shows the interaction between Logic and Model components after the API call `execute("schedule 1 {params}")`,
+where {params} refers to `i/2023-12-27-07-00 a/Seminar`
 ![Interactions Between Logic and Model Components for the `schedule 1 i/2023-12-27-07-00 a/Seminar` Command](images/ScheduleSequenceDiagram.png)
 
 The reason behind implementing this feature this way is partly inspired by the prior implementation of edit feature in AB3.

diff --git a/docs/diagrams/ScheduleSequenceDiagram.puml b/docs/diagrams/ScheduleSequenceDiagram.puml
@@ -18,11 +18,11 @@ box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 end box
 
-[-> LogicManager : execute("schedule 1 i/2023-12-27-07-00 a/Seminar")
+[-> LogicManager : execute("schedule 1 {params}")
 activate LogicManager
 
 
-LogicManager -> AddressBookParser : parseCommand("schedule 1 i/2023-12-27-07-00 a/Seminar")
+LogicManager -> AddressBookParser : parseCommand("schedule 1 {params}")
 activate AddressBookParser
 
 create ScheduleCommandParser
@@ -32,13 +32,13 @@ activate ScheduleCommandParser
 ScheduleCommandParser --> AddressBookParser
 deactivate ScheduleCommandParser
 
-AddressBookParser -> ScheduleCommandParser : parse("1 i/2023-12-27-07-00 a/Seminar")
+AddressBookParser -> ScheduleCommandParser : parse("1 {params}")
 activate ScheduleCommandParser
 
 
 
 create Person
-ScheduleCommandParser -> Person : ScheduleAsField, ScheduleNameAsField, LastModifiedDateTimeAsField
+ScheduleCommandParser -> Person : {params}, LastModifiedDateTime
 activate Person
 Person --> ScheduleCommandParser
 deactivate Person

diff --git a/docs/images/ScheduleSequenceDiagram.png b/docs/images/ScheduleSequenceDiagram.png