Merge branch 'master' into update-dg-diagrams

AY2324S1-CS2103T-T17-3 · Nov 13, 2023 · 165b9a1 · 165b9a1
2 parents 15ab29a + 7fa960b
commit 165b9a1
Show file tree

Hide file tree

Showing 13 changed files with 67 additions and 67 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1165,10 +1165,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list tutors
-2.  TutorConnect shows a list of tutors
-3.  User requests to edit a specific tutor information in the list
-4.  TutorConnect modifies the tutor information
+1.  User requests to list tutors.
+2.  TutorConnect shows a list of tutors.
+3.  User requests to edit a specific tutor information in the list.
+4.  TutorConnect modifies the tutor information.
 
     Use case ends.
 
@@ -1196,10 +1196,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list tutors
-2.  TutorConnect shows a list of tutors
-3.  User requests to delete a specific tutor in the list
-4.  TutorConnect deletes the tutor
+1.  User requests to list tutors.
+2.  TutorConnect shows a list of tutors.
+3.  User requests to delete a specific tutor in the list.
+4.  TutorConnect deletes the tutor.
 
     Use case ends.
 
@@ -1221,10 +1221,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list tutors
-2.  TutorConnect shows a list of tutors
-3.  User requests to add a schedule for a specific tutor in the list
-4.  TutorConnect adds the schedule and displays a list of schedule
+1.  User requests to list tutors.
+2.  TutorConnect shows a list of tutors.
+3.  User requests to add a schedule for a specific tutor in the list.
+4.  TutorConnect adds the schedule and displays a list of schedule.
 
     Use case ends.
 <div style="page-break-after: always;"></div>
@@ -1252,10 +1252,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list schedules
-2.  TutorConnect shows a list of schedules
-3.  User requests to edit a specific schedule information in the list
-4.  TutorConnect modifies the schedule information
+1.  User requests to list schedules.
+2.  TutorConnect shows a list of schedules.
+3.  User requests to edit a specific schedule information in the list.
+4.  TutorConnect modifies the schedule information.
 
     Use case ends.
 
@@ -1283,8 +1283,8 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list schedules by tutor and/or schedule status
-2.  TutorConnect shows a list of schedules
+1.  User requests to list schedules by tutor and/or schedule status.
+2.  TutorConnect shows a list of schedules.
 
     Use case ends.
 
@@ -1308,8 +1308,8 @@ otherwise.
 
 **MSS**
 
-1.  User requests to find schedules by typing in keywords
-2.  TutorConnect shows a list of schedules filtered by keyword entered
+1.  User requests to find schedules by typing in keywords.
+2.  TutorConnect shows a list of schedules filtered by keyword entered.
 
     Use case ends.
 
@@ -1318,10 +1318,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list schedules
-2.  TutorConnect shows a list of schedules
-3.  User requests to delete a specific schedule in the list
-4.  TutorConnect deletes the schedule
+1.  User requests to list schedules.
+2.  TutorConnect shows a list of schedules.
+3.  User requests to delete a specific schedule in the list.
+4.  TutorConnect deletes the schedule.
 
     Use case ends.
 
@@ -1342,10 +1342,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list schedules
-2.  TutorConnect shows a list of schedules
-3.  User requests to mark a specific schedule in the list as completed
-4.  TutorConnect marks the schedule as completed
+1.  User requests to list schedules.
+2.  TutorConnect shows a list of schedules.
+3.  User requests to mark a specific schedule in the list as completed.
+4.  TutorConnect marks the schedule as completed.
 
     Use case ends.
 
@@ -1366,10 +1366,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list schedules
-2.  TutorConnect shows a list of schedules
-3.  User requests to unmark a specific schedule in the list
-4.  TutorConnect unmarks the schedule
+1.  User requests to list schedules.
+2.  TutorConnect shows a list of schedules.
+3.  User requests to unmark a specific schedule in the list.
+4.  TutorConnect unmarks the schedule.
 
     Use case ends.
 
@@ -1379,6 +1379,7 @@ otherwise.
 
   Use case ends.
 <div style="page-break-after: always;"></div>
+
 * 3a. The given index is invalid.
 
     * 3a1. TutorConnect shows an error message.
@@ -1391,10 +1392,10 @@ otherwise.
 
 **MSS**
 
-1.  User requests to list tutors
-2.  TutorConnect shows a list of tutors
-3.  User requests to view schedules for a specific tutor in the list
-4.  TutorConnect displays a list of schedules for the tutor
+1.  User requests to list tutors.
+2.  TutorConnect shows a list of tutors.
+3.  User requests to view schedules for a specific tutor in the list.
+4.  TutorConnect displays a list of schedules for the tutor.
 
     Use case ends.
 
@@ -1426,9 +1427,9 @@ otherwise.
 
 ### Glossary
 
-* **Mainstream OS**: Windows, Linux, Unix, OS-X
-* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor
-* **GUI**: Graphical user interface
+* **Mainstream OS**: Windows, Linux, Unix, OS-X.
+* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor.
+* **GUI**: Graphical user interface.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -1445,7 +1446,7 @@ testers are expected to do more *exploratory* testing.
 
 1. Initial launch
 
-   1. Download the jar file and copy into an empty folder
+   1. Download the jar file and copy into an empty folder.
 
    2. Double-click the jar file Expected: Shows the GUI with a set of sample tutors and schedules. The window size may 
       not be optimum.

diff --git a/docs/diagrams/ChangeThemeSequenceDiagram.puml b/docs/diagrams/ChangeThemeSequenceDiagram.puml
@@ -64,7 +64,7 @@ deactivate ThemeCommand
 LogicManager --> Ui : r
 deactivate LogicManager
 
-Ui --> Ui : handle\nChange\nTheme()
+Ui -> Ui : handle\nChange\nTheme()
 
 [<--Ui
 deactivate Ui

diff --git a/docs/diagrams/DeleteScheduleSequenceDiagram.puml b/docs/diagrams/DeleteScheduleSequenceDiagram.puml
@@ -7,7 +7,7 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":DeleteScheduleCommandParser" as DeleteScheduleCommandParser LOGIC_COLOR
 participant "d:DeleteScheduleCommand" as DeleteScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -65,12 +65,12 @@ create CommandResult
 DeleteScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> DeleteScheduleCommand
+CommandResult --> DeleteScheduleCommand : r
 deactivate CommandResult
 
-DeleteScheduleCommand --> LogicManager : result
+DeleteScheduleCommand --> LogicManager : r
 deactivate DeleteScheduleCommand
 
-[<-- LogicManager
+[<-- LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/diagrams/DeleteTutorSequenceDiagram.puml b/docs/diagrams/DeleteTutorSequenceDiagram.puml
@@ -7,7 +7,7 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":DeleteTutorCommandParser" as DeleteTutorCommandParser LOGIC_COLOR
 participant "d:DeleteTutorCommand" as DeleteTutorCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -59,12 +59,12 @@ create CommandResult
 DeleteTutorCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> DeleteTutorCommand
+CommandResult --> DeleteTutorCommand : r
 deactivate CommandResult
 
-DeleteTutorCommand --> LogicManager : result
+DeleteTutorCommand --> LogicManager : r
 deactivate DeleteTutorCommand
 
-[<-- LogicManager
+[<-- LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/diagrams/FindScheduleSequenceDiagram.puml b/docs/diagrams/FindScheduleSequenceDiagram.puml
@@ -8,7 +8,7 @@ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":FindSchedule\nCommandParser" as FindScheduleCommandParser LOGIC_COLOR
 participant "e:TutorNameContains\nKeywordsPredicate" as TutorNameContainsKeywordsPredicate LOGIC_COLOR
 participant "d:FindSchedule\nCommand" as FindScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -66,12 +66,12 @@ create CommandResult
 FindScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> FindScheduleCommand
+CommandResult --> FindScheduleCommand : r
 deactivate CommandResult
 
-FindScheduleCommand --> LogicManager : result
+FindScheduleCommand --> LogicManager : r
 deactivate FindScheduleCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/diagrams/ListScheduleSequenceDiagram.puml b/docs/diagrams/ListScheduleSequenceDiagram.puml
@@ -7,7 +7,7 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":ListSchedule\nCommandParser" as ListScheduleCommandParser LOGIC_COLOR
 participant "l:ListSchedule\nCommand" as ListScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 participant ":Person" as Person LOGIC_COLOR
 participant ":Tutor\nPredicate" as TutorPredicate LOGIC_COLOR
 participant ":Status\nPredicate" as StatusPredicate LOGIC_COLOR
@@ -104,12 +104,12 @@ create CommandResult
 ListScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> ListScheduleCommand
+CommandResult --> ListScheduleCommand : r
 deactivate CommandResult
 
-ListScheduleCommand --> LogicManager : result
+ListScheduleCommand --> LogicManager : r
 deactivate ListScheduleCommand
 
-[<-- LogicManager
+[<-- LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/diagrams/ListTutorSequenceDiagram.puml b/docs/diagrams/ListTutorSequenceDiagram.puml
@@ -6,7 +6,7 @@ box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant "d:ListTutorCommand" as ListTutorCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -41,12 +41,12 @@ create CommandResult
 ListTutorCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> ListTutorCommand
+CommandResult --> ListTutorCommand : r
 deactivate CommandResult
 
-ListTutorCommand --> LogicManager : result
+ListTutorCommand --> LogicManager : r
 deactivate ListTutorCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/images/DeleteScheduleSequenceDiagram.png b/docs/images/DeleteScheduleSequenceDiagram.png
diff --git a/docs/images/DeleteTutorSequenceDiagram.png b/docs/images/DeleteTutorSequenceDiagram.png
diff --git a/docs/images/FindScheduleSequenceDiagram.png b/docs/images/FindScheduleSequenceDiagram.png
diff --git a/docs/images/ListScheduleSequenceDiagram.png b/docs/images/ListScheduleSequenceDiagram.png
diff --git a/docs/images/ListTutorSequenceDiagram.png b/docs/images/ListTutorSequenceDiagram.png
diff --git a/docs/team/jweng88.md b/docs/team/jweng88.md
@@ -5,7 +5,7 @@ title: Joshua Weng Hao’s Project Portfolio Page
 
 ### Project: Tutor Connect
 
-This is an address book made for tuition centre managers to easily track, schedule, 
+This is an **address book made for tuition centre managers** to easily track, schedule, 
 and notify tutors of their upcoming schedule, optimised for users who prefer a CLI.
 
 Given below are my contributions to the project.
@@ -16,7 +16,7 @@ Given below are my contributions to the project.
 * **Enhancements implemented**:
   * **New feature:** Added the ability to mark schedules. 
   (Pull request [#144](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/144))
-    * What it does: Allows the user to mark a specified schedule as MISSED or COMPLETED.
+    * What it does: Allows the user to mark a specified schedule as `MISSED` or `COMPLETED`.
     * Justification: This feature improves the product by allowing users to create and set the status of a specified
     schedule.
     * Highlights: Implementing this feature posed some challenges as it required the addition of the status field in 
@@ -47,7 +47,6 @@ Given below are my contributions to the project.
     * User Guide
         * Added details of list tutor feature [#47](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/47),
         [#105](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/105), 
-        [#161](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/161), 
         [#233](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/233).
         * Added details of delete tutor feature [#48](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/48), 
         [#53](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/53), 
@@ -64,14 +63,14 @@ Given below are my contributions to the project.
         [#161](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/161).
         * Added implementation details of mark schedule feature 
         [#320](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/320).
-        * Added implementation details for SplitMainWindow to display both tutor and schedule list together 
+        * Added implementation details for Split MainWindow to display both tutor and schedule list together 
         [#320](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/320).
-        * Added detailed instructions for manual testing for all features 
+        * Added detailed instructions for manual testing of all features 
         [#320](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/320).
         * Update acknowledgements section [#320](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/320).
 
 * **Contribution to team-based tasks**:
-    * Implement schedule structure: update AddressBook to include schedules. (Pull request 
+    * Implement schedule structure: update AddressBook to include schedules. (Pull requests 
     [#98](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/98),
     [#101](https://github.com/AY2324S1-CS2103T-T17-3/tp/pull/101))
     * Standardising formatting and proofreading UG and DG