Skip to content

Commit

Permalink
Update UG according to review
Browse files Browse the repository at this point in the history
  • Loading branch information
yyyaohhh committed Nov 12, 2023
1 parent 443edd7 commit 8bfc529
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Provides you with information that is useful to know.
5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Some example commands you can try:

* `info CS1101S` : Shows you information about the module CS1101S, which are the module code, module title, modular credit and module description of CS1101S.
* `info CS1101S` : Shows you information about the module CS1101S, which are the module code, module title, modular credit and module description of `CS1101S`.

* `add CS2030S y/1 s/2 g/IP` : Adds the module CS2030S to your study plan of semester 2 in year 1, and marks its grade as `IP` (In Progress).

Expand Down Expand Up @@ -172,7 +172,7 @@ In ModCraft, you can specify the **year, semester and grade** of each module whe

<br>

Below shows you the process for adding a module the Advance Placement semester in ModCraft. The module `CS1010` is being added to Year 0 (the Advance Placement semester).
Below shows you the process for adding a module to the Advance Placement semester in ModCraft. The module `CS1010` is being added to Year 0 (the Advance Placement semester).

<div style="display:flex; justify-content:space-around; align-items:center;">
<img src="images/ImagesForUG/ap-before.png" alt="Before executing add command" style="height:400px; margin:20px;">
Expand All @@ -181,7 +181,7 @@ Below shows you the process for adding a module the Advance Placement semester i

<br>

Below shows you the process for adding a module to the Special Term (ST) in ModCraft. The module `CS3230` is being added to Year 1, Special Term 1.
Below shows you the process for adding a module to one of the Special Term (ST) in ModCraft. The module `CS3230` is being added to Year 1, Special Term 1.

<div style="display:flex; justify-content:space-around; align-items:center;">
<img src="images/ImagesForUG/st-before.png" alt="Before executing add command" style="height:400px; margin:20px;">
Expand Down Expand Up @@ -241,7 +241,7 @@ Below shows you the process for executing the `add` command in ModCraft.

### Editing a module: `edit`

Changes an attribute of a module **only if it exists**. Useful if you want to update information about a module or has made a mistake while adding a module.
Changes an attribute of a module **only if it exists**. Useful if you want to update information about a module or have made a mistake while adding a module.

Format: `edit MODULE [y/YEAR] [s/SEM] [g/GRADE]`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public Module toModelType() throws IllegalValueException {

if (title == null) {
throw new IllegalValueException(
String.format(MISSING_FIELD_MESSAGE_FORMAT, ModuleName.class.getSimpleName()));
String.format(MISSING_FIELD_MESSAGE_FORMAT, ModuleName.class.getSimpleName()));
}
if (!ModuleName.isValidName(title)) {
throw new IllegalValueException(ModuleName.MESSAGE_CONSTRAINTS);
Expand Down

0 comments on commit 8bfc529

Please sign in to comment.