Skip to content

Commit 2fd700d

Browse files
getsquaredgetsquared
authored
Merge pull request #110 from solomonng2001/update-user-guide-after-milestone1.3
Add sort feature in miscellaneous
2 parents d7eafc6 + d6b7a1f commit 2fd700d

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

‎docs/UserGuide.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,21 @@ Examples:
647647

648648
## Miscellaneous
649649

650+
### Sorting the client list : `sort`
651+
652+
You can sort the client list with `sort`:
653+
654+
Format: `sort CRITERIA o/ORDER`
655+
656+
* Sorts the client list by the specified `CRITERIA`. Sorting `CRITERIA` is *case-insensitive*.
657+
* Sortng `CRITERIA` can be `name`, `phone`, `email`, `address`, `birthday`, `priority`, `lastmet`, `schedule`.
658+
* Sorting `ORDER` is specified by `ORDER` and can be `asc` for ascending or `desc` for descending. Sorting `ORDER` is *case-insensitive*
659+
660+
Examples:
661+
* `sort name o/asc` sorts the client list by name in ascending order.
662+
* `sort priority o/desc` sorts the client list by priority in descending order.
663+
* `sort lastmet o/asc` sorts the client list by last met date in ascending order.
664+
650665
### Viewing help : `help`
651666

652667
You can look for help by typing `help`.
@@ -756,20 +771,21 @@ Furthermore, certain edits can cause the ClientCare to behave in unexpected ways
756771

757772
# Command summary
758773

759-
| Action | Format, Examples |
760-
|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
761-
| [**Add**](#adding-a-client-add) | `add n/NAME c/PHONE_NUMBER e/EMAIL a/ADDRESS d/BIRTHDAY p/PRIORITY [t/TAG]…​` <br/> e.g.`add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 d/1990-01-01 p/medium t/friend t/colleague` |
762-
| [**Delete**](#deleting-a-client-delete) | `delete INDEX`<br/> e.g. `delete 3` |
763-
| [**Edit**](#editing-a-client-edit) | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [d/BIRTHDAY] [p/PRIORITY] [t/TAG]…​`<br/> e.g.`edit 2 n/James Lee e/jameslee@example.com` |
764-
| [**List**](#listing-all-clients-list) | `list` |
765-
| [**View**](#viewing-a-client-view) | `view INDEX`<br/> e.g, `view 1` |
766-
| [**Find**](#finding-a-client-find) | `find KEYWORD [MORE_KEYWORDS]`<br/> e.g. `find James Jake` |
767-
| [**Remark**](#adding-notes-to-clients-remark) | `remark INDEX r/REMARK`<br/> e.g. `remark 3 r/Has 2 school-age children and 1 elderly dependent` |
768-
| [**Clear**](#clearing-all-entries-clear) | `clear` |
769-
| [**LastMet**](#updating-last-met-met) | `met INDEX [d/DATE]`<br/> e.g. `met 2 d/2023-05-07` |
770-
| [**Schedule**](#scheduling-appointments-schedule) | `schedule INDEX [d/DATETIME]`<br/> e.g. `schedule 2 d/2023-05-07 22:00` | |
771-
| [**Mark**](#marking-appointments-mark) | `mark INDEX`<br/> e.g. `mark 2` | |
772-
| [**Add Policy**](#adding-a-policy-addpolicy) | `addpolicy INDEX n/POLICY_NAME i/POLICY_ID` <br/> e.g. `addpolicy 1 n/Life i/1` |
773-
| [**Delete Policy**](#deleting-a-policy-deletepolicy) | `deletepolicy INDEX i/POLICY_ID` <br/> e.g. `deletepolicy 1 i/1` |
774-
| [**Help**](#viewing-help-help) | `help` |
775-
| [**Exit**](#exiting-the-program-exit) | `exit` |
774+
| Action | Format, Examples |
775+
|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
776+
| [**Add**](#adding-a-client-add) | `add n/NAME c/PHONE_NUMBER e/EMAIL a/ADDRESS d/BIRTHDAY p/PRIORITY [t/TAG]…​` <br/> e.g.`add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 d/1990-01-01 p/medium t/friend t/colleague` |
777+
| [**Delete**](#deleting-a-client-delete) | `delete INDEX`<br/> e.g. `delete 3` |
778+
| [**Edit**](#editing-a-client-edit) | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [d/BIRTHDAY] [p/PRIORITY] [t/TAG]…​`<br/> e.g.`edit 2 n/James Lee e/jameslee@example.com` |
779+
| [**List**](#listing-all-clients-list) | `list` |
780+
| [**View**](#viewing-a-client-view) | `view INDEX`<br/> e.g, `view 1` |
781+
| [**Find**](#finding-a-client-find) | `find KEYWORD [MORE_KEYWORDS]`<br/> e.g. `find James Jake` |
782+
| [**Remark**](#adding-notes-to-clients-remark) | `remark INDEX r/REMARK`<br/> e.g. `remark 3 r/Has 2 school-age children and 1 elderly dependent` |
783+
| [**Clear**](#clearing-all-entries-clear) | `clear` |
784+
| [**LastMet**](#updating-last-met-met) | `met INDEX [d/DATE]`<br/> e.g. `met 2 d/2023-05-07` |
785+
| [**Schedule**](#scheduling-appointments-schedule) | `schedule INDEX [d/DATETIME]`<br/> e.g. `schedule 2 d/2023-05-07 22:00` | |
786+
| [**Mark**](#marking-appointments-mark) | `mark INDEX`<br/> e.g. `mark 2` | |
787+
| [**Add Policy**](#adding-a-policy-addpolicy) | `addpolicy INDEX n/POLICY_NAME i/POLICY_ID` <br/> e.g. `addpolicy 1 n/Life i/1` |
788+
| [**Delete Policy**](#deleting-a-policy-deletepolicy) | `deletepolicy INDEX i/POLICY_ID` <br/> e.g. `deletepolicy 1 i/1` |
789+
| [**Sort**](#sorting-the-client-list) | `sort CRITERIA o/ORDER` <br/> e.g. `sort priority o/desc` |
790+
| [**Help**](#viewing-help-help) | `help` |
791+
| [**Exit**](#exiting-the-program-exit) | `exit` |

0 commit comments

Comments
 (0)