Skip to content

Commit

Permalink
Merge pull request #250 from peasantbird/update-UG
Browse files Browse the repository at this point in the history
Update UG for sort, undo/redo, help and exit
  • Loading branch information
peasantbird authored Nov 15, 2023
2 parents 0569ce0 + 66e893b commit 16ff6b9
Showing 1 changed file with 34 additions and 21 deletions.
55 changes: 34 additions & 21 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -636,8 +636,10 @@ Ryan; Phone: 91234567; Email: [email protected]; Address: My Secret Home; Selling A

### Sorting buyers: `bsort`

Sorts the buyers' list either by a provided prefix and direction, or by the list's default order when no prefix and
direction is provided.
Elevate your contact list through organisation based on your priorities.

The `bsort` command allows you to quickly organise your buyer contacts by various criteria, so that you can sieve out
your most important contacts to maintain and the most valuable opportunities you have.

Format: `bsort [PREFIX/DIRECTION]`
* `PREFIX`: Choose <u>one</u> of:
Expand All @@ -647,8 +649,14 @@ Format: `bsort [PREFIX/DIRECTION]`
* `prio` - sort by **priority**
* `DIRECTION`: "a" OR "d" for ascending or descending respectively

<box type="tip">

**Tip:** When no prefix and direction is provided, `bsort` sorts by the list's original order.

</box>

Examples:
* `bsort` to sort by default
* `bsort` to sort by original order
* `bsort n/d` to sort by name descending

Precise outputs when the command succeeds:
Expand Down Expand Up @@ -690,8 +698,10 @@ valid prefix (`n`, `ah`, `i` or `prio`).

### Sorting sellers: `ssort`

Sorts the sellers' list either by a provided prefix and direction, or by the list's default order when no prefix and
direction is provided.
Elevate your contact list through organisation based on your priorities.

The `ssort` command allows you to quickly organise your seller contacts by various criteria, so that you can sieve out
your most important contacts to maintain and the most valuable opportunities you have.

Format: `ssort [PREFIX/DIRECTION]`
* `PREFIX`: Choose <u>one</u> of:
Expand All @@ -701,6 +711,12 @@ Format: `ssort [PREFIX/DIRECTION]`
* `prio` - sort by **priority**
* `DIRECTION`: "a" OR "d" for ascending or descending respectively

<box type="tip">

**Tip:** When no prefix and direction is provided, `ssort` sorts by the list's original order.

</box>

Examples:
* `ssort` to sort by default
* `ssort n/d` to sort by name descending
Expand Down Expand Up @@ -743,17 +759,14 @@ Example: ssort prio/d

### Undoing previous action: `undo`

Undoes the previous action. Only undoes actions that changes the contacts in RTPM, and does not undo actions that
changes the list view (i.e. `list`, `filter`, `sort`).
Made a mistake? The `undo` command allows you to undo the previous action, easily correcting your mistakes and keeping
your contact list on track.

Format: `undo`

<box type="tip">

**Tip:**

Using `undo` multiple times will undo multiple actions in order.

**Tip:** Using `undo` multiple times will undo multiple actions in order.

</box>

Expand All @@ -769,17 +782,14 @@ Precise outputs when the command fails:

### Redoing previous action: `redo`

Restores the previously undone action. Only redoes actions that changes the contacts in RTPM, and does not redo actions
that changes the list view (i.e. `list`, `filter`, `sort`).
The `redo` command allows you to restore a previously undone action, making it easy to go back to any state and
continue working from there.

Format : `redo`

<box type="tip">

**Tip:**

Using `redo` multiple times will redo multiple actions in order.

**Tip:** Using `redo` multiple times will redo multiple actions in order.

</box>

Expand All @@ -805,22 +815,25 @@ Precise outputs when the command fails:

### Viewing help: `help`

Lost? This command shows a message explaining how to access the online version of the help page,
including this user guide, so that you can get back to work.
Unsure of how to use our system or forgot the available commands? The `help` command allows you to access our user
guide, ensuring that you have all the information you need at your fingertips.

Format: `help`

--------------------------------------------------------------------------------------------------------------------

### Exiting the program: `exit`

Done already? We hope you had a good experience! This command closes RTPM.
Wrap up your contact management session and start making the deals happen.

The `exit` command allows you to terminate the program gracefully and securely, safeguarding all data and changes
you've made during the session.

Format: `exit`

<box type="info">

Upon exit, the latest data is saved again to your computer, by default at data/rtpm.json.
**Note:** Upon exit, the latest data is saved to your computer at data/rtpm.json.

</box>

Expand Down

0 comments on commit 16ff6b9

Please sign in to comment.