Skip to content

Commit

Permalink
Merge branch 'master' into miljyy-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
inezkok authored Nov 13, 2023
2 parents abf7a43 + e0eb005 commit c734e22
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 20 deletions.
16 changes: 16 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1918,6 +1918,22 @@ Solution:
`This leave period exceeds the number of leaves remaining for this employee`<br>
`Number of leaves remaining: 1`

### Unable to view the number of overtime hours remaining when updating overtime hours that exceeds the range of allowed number of overtime hours

Problem:
* In our current implementation, if a user tries to update the number of overtime hours for an employee and exceeds the
maximum number of allowed overtime hours or make it fall below zero, the app only displays an error message
telling the user it exceeds the range of allowed number of overtime hours.
* However, the app does not show the remaining number of overtime hours, so the fastest method is to use report command to display the current amount of
overtime hours taken by the employee and perform manual subtraction to obtain remaining number of overtime hours.

Solution:
* We plan to revamp the error messages pertaining to this issue to display as much information as possible to the user,
in this case the remaining number of overtime hours.
* In this case, it is to change the error message into this:<br>
`Number of overtime hours should not be above 72 or below 0`<br>
`Number of overtime hours remaining: 2`

### Unclear error message for invalid email address

Problem:
Expand Down
20 changes: 0 additions & 20 deletions docs/diagrams/SortSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
participant ":AddressBook" as AddressBook MODEL_COLOR
participant ":UniqueEmployeeList" as UniqueEmployeeList MODEL_COLOR
end box
[-> LogicManager : execute("sort f/salary in/asc")
activate LogicManager
Expand Down Expand Up @@ -49,27 +47,9 @@ deactivate AddressBookParser
LogicManager -> SortCommand : execute()
activate SortCommand

SortCommand -> SortCommand : handleSortingOrder(model, "salary", "asc")
activate SortCommand

SortCommand --> SortCommand
deactivate SortCommand

SortCommand -> Model : updateSortedEmployeeListAscending("salary");
activate Model

Model -> AddressBook : updateSortedEmployeeListAscending("salary")
activate AddressBook

AddressBook -> UniqueEmployeeList : sortEmployeesAscending("salary");
activate UniqueEmployeeList

UniqueEmployeeList --> AddressBook
deactivate UniqueEmployeeList

AddressBook --> Model
deactivate AddressBook

Model --> SortCommand
deactivate Model

Expand Down
Binary file modified docs/images/SortSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c734e22

Please sign in to comment.