Skip to content

Commit

Permalink
Update User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ketweeen committed Oct 5, 2023
1 parent 3e8900b commit 7ce30ca
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,16 @@ Examples:

Shows a list of all persons in the address book.

Format: `list`
Format: `list s/ATTRIBUTE`

* `s/ATTRIBUTE` is completely **optional**, on default will NOT be sorted.
* As of v1.2, the attributes that are supported are `name` and `email`.
* Attribute is case-insensitive: `list s/NAME` and `list s/name` return the same result.
* The result will be sorted in **ascending** order.

Examples:
* `list` Shows a list of all persons.
* `list s/name` Show a list of all persons, sorted by name in ascending order.

### Editing a person : `edit`

Expand Down Expand Up @@ -241,5 +250,5 @@ Action | Format, Examples
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**List** | `list s/ATTRIBUTE` <br> e.g. `list s/name`
**Help** | `help`

0 comments on commit 7ce30ca

Please sign in to comment.