Skip to content

Commit

Permalink
Merge pull request #187 from rayray39/branch-UpdateUG
Browse files Browse the repository at this point in the history
Update User Guide
  • Loading branch information
rayray39 authored Nov 6, 2024
2 parents 7c9b487 + 5432375 commit e491902
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# SocialBook User Guide

SocialBook is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SocialBook can get your contact management tasks done faster than traditional GUI apps.
SocialBook is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SocialBook can get your contact management tasks done faster than traditional GUI apps.

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -187,14 +187,16 @@ Examples:

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

Format: `sort parameter/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 **a**/**asc**/**ascend**/**ascending**
* Order can be specified as descending by **d**/**desc**/**descend**/**descending**
* Sorts the contacts according to the parameter, in the specified order.
* By default, if `ORDER` is omitted, contacts will be sorted in ascending order based on the `PARAMETER`.
* An ascending order can be specified by replacing `ORDER` with `ascending` or its short form `asc`.
* A descending order can be specified by replacing `ORDER` with `descending` or its short form `desc`.

Examples:
* `sort n/` sorts by name in ascending order.
* `sort d/`, `sort d/asc`, `sort d/ascending` are all equivalent, and they sort the date of last visit in ascending order.
* `sort d/desc` sorts by date of last visit in descending order.

### Viewing a person : `view`
Expand Down

0 comments on commit e491902

Please sign in to comment.