Skip to content

Commit

Permalink
Add replace sort function documentation in UG
Browse files Browse the repository at this point in the history
  • Loading branch information
nerdyboy98 committed Mar 5, 2023
1 parent 0e40d04 commit c0f75f7
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,24 @@ Examples:
* `sort consultation date nonreverse`


### Replace existing list with sorted list: `replace sort recur`

Similar to the sorting command, except with a "replace" keyword in front. This function overwrites the recurring event list with a sorted one with the sorting parameters specified.

There should be a prompt to ask if the TA wants to proceed with overwriting as the process is irreversible.

Format: `replace sort [type] [sorting method] [sorting order]`

Examples:



* `replace sort lab alphabetical reverse`
* `replace sort tutorial duration nonreverse`
* `replace sort consultation date nonreverse`



### Help tutorial for recurring events: `help recur`

Returns a list of instructions on what the event encompasses and also what parameters and input format is required to successfully create said event.
Expand Down Expand Up @@ -955,11 +973,28 @@ Examples:
<td>
<ul>

<li><code>sort labs alphabetical</code>
<li><code>sort labs alphabetical reverse</code>

<li><code>sort consultation date nonreverse</code>

<li><code>sort tutorial duration nonreverse</code>
</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Replace sort recur</strong>
</td>
<td><code>replace sort [type] [sorting method]</code>
</td>
<td>
<ul>

<li><code>replace sort labs alphabetical reverse</code>

<li><code>sort consultation date</code>
<li><code>replace sort consultation date nonreverse</code>

<li><code>sort tutorial duration</code>
<li><code>replace sort tutorial duration nonreverse</code>
</li>
</ul>
</td>
Expand Down

0 comments on commit c0f75f7

Please sign in to comment.