Merge pull request #266 from AY2324S1-CS2103T-W12-1/v1.4b-inezkok-dg

Minor edits to DG
AY2324S1-CS2103T-W12-1 · Nov 13, 2023 · 56ea75a · 56ea75a
2 parents 73f7a88 + 206e05c
commit 56ea75a
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 20 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -79,7 +79,7 @@ The bulk of the app's work is done by the following four components:
 
 **How the architecture components interact with each other**
 
-The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
+The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete EID1234-5678`.
 
 <img src="images/ArchitectureSequenceDiagram.png" width="574" />
 
@@ -122,7 +122,7 @@ Here's a (partial) class diagram of the `Logic` component:
 
 The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete 1")` API call as an example.
 
-![Interactions Inside the Logic Component for the `delete 1` Command](images/DeleteSequenceDiagram.png)
+![Interactions Inside the Logic Component for the `delete EID1234-5678` Command](images/DeleteSequenceDiagram.png)
 
 <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 reaches the end of diagram.
 </div>
@@ -817,8 +817,6 @@ Given below is an example usage scenario for the command.
 * The Employee List will be updated to contain only employees which have leaves taken on the specified date.
 
 
-_{more aspects and alternatives to be added}_
-
 ### Overtime feature
 
 The overtime feature allows HouR users to manage employee overtime hours.
@@ -1846,6 +1844,7 @@ Another feature we are proud of is our `report` feature that allows our users to
 
 Overall, we are proud of our project, and we believe that we have done our best with all the constraints and challenges we faced. We are happy with the result and believe that our product will meet the needs of our target audience.
 
+
 ## Planned Enhancements
 
 ### Remark not shown in GUI employee list

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -18,7 +18,7 @@ HouR is a **desktop app for managing employee records, optimized for use via a C
 - [Using this guide](#using-this-guide)
 - [Useful Notations and Glossary](#useful-notations-and-glossary)
 - [Quick Start](#quick-start)
-- [Navigating the GUI](#navigating-the-graphical-user-interface--gui-)
+- [Navigating the GUI](#navigating-the-gui)
 - [Features](#features)
   - [General Commands](#general-commands)
       - [Viewing Help](#viewing-help--help): `help`
@@ -69,7 +69,7 @@ The following glossary table provides clarification on commonly-used terms as we
 |      Symbol      | Meaning                                                                                                                                                                                                                                             |
 |:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 |       GUI        | GUI stands for Graphical User Interface and it represents the visual display of HouR that users can see when the application is run.                                                                                                                |
-|  GUI component   | A subsection of the GUI. For more information on specific GUI components, refer to this [section](#navigating-the-graphical-user-interface--gui-).                                                                                                  |
+|  GUI component   | A subsection of the GUI. For more information on specific GUI components, refer to this [section](#navigating-the-gui).                                                                                                                             |
 |       CLI        | CLI stands for Command Line Interface and it represents a text-based user interface to interact with the application.                                                                                                                               |
 |     Command      | An input from the user that tells HouR to perform an action. View HouR's [command summary](#command-summary).                                                                                                                                       |
 |    Parameter     | Parameters are like fields in a form you are required to fill up. They are information needed to be passed together with the command so that it can be executed. More information regarding parameters can be found [here](#parameter-information). |
@@ -144,9 +144,9 @@ Performing these instructions may result in non-deterministic behaviour of data
 
 --------------------------------------------------------------------------------------------------------------------
 
-## Navigating the Graphical User Interface (GUI)
+## Navigating the GUI
 
-HouR comes with a GUI to allow for nice visual feedback for our users. Here is a quick run-through of the different sections of our GUI, as well as some notes regarding the use of the GUI.
+HouR comes with a Graphical User Interface (GUI) to allow for nice visual feedback for our users. Here is a quick run-through of the different sections of our GUI, as well as some notes regarding the use of the GUI.
 
 ### Quick Orientation
 
@@ -323,7 +323,7 @@ Format: `list`
 
 ![list success](images/ug-pics/list.png)
 
-### Finding employees: `find`
+### Finding employees : `find`
 
 Finds employees whose name, position, department, phone number, email, or ID contain any of the given keywords.
 

diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml
@@ -8,13 +8,13 @@ Participant ":Logic" as logic LOGIC_COLOR
 Participant ":Model" as model MODEL_COLOR
 Participant ":Storage" as storage STORAGE_COLOR
 
-user -[USER_COLOR]> ui : "delete 1"
+user -[USER_COLOR]> ui : "delete EID1234-5678"
 activate ui UI_COLOR
 
-ui -[UI_COLOR]> logic : execute("delete 1")
+ui -[UI_COLOR]> logic : execute("delete EID1234-5678")
 activate logic LOGIC_COLOR
 
-logic -[LOGIC_COLOR]> model : deletePerson(p)
+logic -[LOGIC_COLOR]> model : deleteEmployee(p)
 activate model MODEL_COLOR
 
 model -[MODEL_COLOR]-> logic

diff --git a/docs/diagrams/UiClassDiagram.puml b/docs/diagrams/UiClassDiagram.puml
@@ -11,8 +11,8 @@ Class UiManager
 Class MainWindow
 Class HelpWindow
 Class ResultDisplay
-Class PersonListPanel
-Class PersonCard
+Class EmployeeListPanel
+Class EmployeeCard
 Class StatusBarFooter
 Class CommandBox
 }
@@ -32,26 +32,26 @@ UiManager .left.|> Ui
 UiManager -down-> "1" MainWindow
 MainWindow *-down->  "1" CommandBox
 MainWindow *-down-> "1" ResultDisplay
-MainWindow *-down-> "1" PersonListPanel
+MainWindow *-down-> "1" EmployeeListPanel
 MainWindow *-down-> "1" StatusBarFooter
 MainWindow --> "0..1" HelpWindow
 
-PersonListPanel -down-> "*" PersonCard
+EmployeeListPanel -down-> "*" EmployeeCard
 
 MainWindow -left-|> UiPart
 
 ResultDisplay --|> UiPart
 CommandBox --|> UiPart
-PersonListPanel --|> UiPart
-PersonCard --|> UiPart
+EmployeeListPanel --|> UiPart
+EmployeeCard --|> UiPart
 StatusBarFooter --|> UiPart
 HelpWindow --|> UiPart
 
-PersonCard ..> Model
+EmployeeCard ..> Model
 UiManager -right-> Logic
 MainWindow -left-> Logic
 
-PersonListPanel -[hidden]left- HelpWindow
+EmployeeListPanel -[hidden]left- HelpWindow
 HelpWindow -[hidden]left- CommandBox
 CommandBox -[hidden]left- ResultDisplay
 ResultDisplay -[hidden]left- StatusBarFooter

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