Skip to content

Commit

Permalink
Merge pull request #143 from AbdulrahmanAlRammah/Sort_UG_DG_Diagram
Browse files Browse the repository at this point in the history
Update UG and Diagrams
  • Loading branch information
Andrew22Teoh authored Oct 24, 2024
2 parents 8486b8a + 8a54c62 commit 8b2d792
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,20 @@ Examples:
* `remark 1 r/Financial Issues` Adds the remark of the 1st person to be `Financial Issues`.
* `remark 1 r/` Clears remarks (if any) of the 1st person.

### Sorting the person list : `sort`

Sorts the list of persons being viewed by name or date of last visit in ascending or descending order.

Format: `sort parameter/order`

* Sorts the displayed list of persons according to the specified order.
* Order can be specified as ascending by leaving the order blank or **asc**/**ascending**
* Order can be specified as descending by **descending**/**desc**

Examples:
* `sort n/` sorts by name in ascending order.
* `sort d/descending` sorts by date of last visit in descending order.

### Clearing all entries : `clear`

Clears all entries from the address book.
Expand Down Expand Up @@ -255,4 +269,5 @@ Action | Format, Examples
**View** | `view INDEX`<br> e.g.,`view 1`
**Help** | `help`
**Seed** | `seed`
**Sort** | `sort parameter/order` <br> e.g., `sort n/ascending`
**Remark** | `remark INDEX r/REMARK`
4 changes: 3 additions & 1 deletion docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Class ModelManager
Class UserPrefs

Class UniquePersonList
Class PersonComparator
Class Person
Class Address
Class Email
Expand All @@ -39,6 +40,7 @@ ModelManager -right-> "1" UserPrefs
UserPrefs .up.|> ReadOnlyUserPrefs

AddressBook *--> "1" UniquePersonList
UniquePersonList .left.> PersonComparator
UniquePersonList --> "~* all" Person
Person *--> Name
Person *--> Phone
Expand All @@ -47,7 +49,7 @@ Person *--> Address
Person *--> "*" Tag
Person *--> EmergencyContact
Person *--> DateOfLastVisit
Person *--> Remark
Person *--> "1" Remark

Person -[hidden]up--> I
UniquePersonList -[hidden]right-> I
Expand Down

0 comments on commit 8b2d792

Please sign in to comment.