Skip to content

Commit

Permalink
Merge pull request #312 from chewjh1234/branch-add-error-table
Browse files Browse the repository at this point in the history 
Update UG -Sort
  • Loading branch information
@leontan2
leontan2 committed Nov 15, 2023
2 parents 2fa8517 + c05633d commit d0b0a84
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,12 @@ Examples:

</div>

**Here's what you should do when you encounter an error:**

| Error Encountered | Reason | Solution |
|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Invalid command format!` | You may have misspelled or entered the wrong sorting criterion. <br> Otherwise, you may have added extraneous characters in the command. | Verify that the criterion entered is spelt correctly in lowercase. <br> Ensure that you did not leave the hyphen out in `name-ascending` or `name-descending`. |

[Back to Table of Contents](#table-of-contents)

#### Sorting by Course: `sort course`
Expand Down Expand Up @@ -716,6 +722,12 @@ Examples:

In both cases, students with the same number of courses taken are arranged by their names similar to the [`sort name`](#sorting-by-name-sort-name) command.

**Here's what you should do when you encounter an error:**

| Error Encountered | Reason | Solution |
|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Invalid command format!` | You may have misspelled or entered the wrong sorting criterion. <br> Otherwise, you may have added extraneous characters in the command. | Verify that the criterion entered is spelt correctly in lowercase. <br> Ensure that you did not leave the hyphen out in `size-ascending` or `size-descending`. |

[Back to Table of Contents](#table-of-contents)

#### Sorting by Tags: `sort tags`
Expand All @@ -740,6 +752,14 @@ Examples:
For example, a student with both 'Friend' and 'Emergency' tags will be placed in NUSCoursemates with other students tagged as 'Friend'.
</div>

**Here's what you should do when you encounter an error:**

| Error Encountered | Reason | Solution |
|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Invalid command format!` | You may have misspelled or entered the wrong sorting criterion, `tags`. <br> Otherwise, you may have added extraneous characters after it. | Verify that the command, `sort tags`, is spelt correctly in lowercase. <br> Unlike the other `sort` commands, no additional sorting criterion should be entered for `sort tags`. |

Please be patient with us as we work hard to bring you better sorting features!

[Back to Table of Contents](#table-of-contents)

## Features - Clearing Student Profiles
Expand Down

0 comments on commit d0b0a84

Please sign in to comment.