Skip to content

Commit

Permalink
Merge pull request #313 from tituschewxj/fix-setcrs
Browse files Browse the repository at this point in the history
docs: Fix setcrs UG
  • Loading branch information
tituschewxj authored Apr 15, 2024
2 parents 060dea5 + dde4f8a commit 4664dc5
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,9 +347,7 @@ The help window is resizable, so you can {{ macros.semiBold('easily reposition a

Sets the course code in question.

Course is shown at the top of the window.

Course is shown at the top of the window.
The course code is shown at the top of TAPro's main window.

<box type="definition" icon=":fa-solid-spell-check:" light>

Expand All @@ -361,22 +359,26 @@ Course is shown at the top of the window.
Course codes are case-insensitive.

</box>
<box type="warning" light>

Here is the output in the command results when the `setcrs` command is successful:

**Course code should follow the format `XX1234Y`, where `Y` is optional:**

<box type="warning" light>
<box type="info" light>

Course code should follow the format "XX1234Y", Y is optional.
`X` and `Y` can be any letters, while `1234` can be any four-digit number.
</box>
<box type="tip" light>

X and Y can be any letters, while 1234 can be any 4-digit number.
Course code is meant for CS coded courses, hence only two prefix letters are allowed.
</box>

Course code is meant for CS coded courses, hence only 2 prefix letters are allowed.
<box type="wrong" light>

When an invalid course code is entered, the following error message appears:

<img src="images/ug/setcrs_error.png" alt="Setcrs Error" class="rounded-image" width="800px"/>
</box>
</box>

{{ newPage }}

Expand Down

0 comments on commit 4664dc5

Please sign in to comment.