From 823189d6477bd7f62c7d2e77cf9bbc3894e6b6b4 Mon Sep 17 00:00:00 2001 From: rocketninja7 Date: Thu, 9 Nov 2023 18:05:44 +0800 Subject: [PATCH 1/7] Fix formatting, grammar and consistency --- docs/UserGuide.md | 58 ++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 31 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 404d039ded2..dd2c454b433 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -16,7 +16,7 @@ ModCraft can serve as a **study planner** for your journey in NUS. With ModCraft * Add in modules you have taken * Add in modules you plan to take -* delete modules you would like to drop +* Delete modules you would like to drop * Update grades of your modules **And many more!** @@ -33,26 +33,24 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour. -**Note Box** - +:information_source: **Note:** Provides you with information that is useful to know. - + -------------------------------------------------------------------------------------------------------------------- ## Table of Contents 1. [Quick start](#quick-start) -2. [Features](#features) - 2.1. [Viewing help](#viewing-help--help) - 2.2. [Modules](#modules) - 2.2.1. [Adding a module](#adding-a-module-add) - 2.2.2. [Editing a module](#editing-a-module-edit) - 2.2.3. [Deleting a module](#deleting-a-module--delete) - 2.2.4. [Finding information about a module](#finding-information-about-a-module-info) - 2.3. [Calculating the total current CAP](#calculating-the-total-current-cap-calculatecap) - 2.4. [Calculating the total current Modular Credits (MCs)](#calculating-the-total-current-modular-credits-mcs-calculatemc) - 2.5. [Exiting the program](#exiting-the-program--exit) - 2.6. [Saving the data](#saving-the-data) +2. [Features](#features) + 2.1. [Viewing help](#viewing-help-help) + 2.2. [Modules](#modules) + 2.2.1. [Adding a module](#adding-a-module-add) + 2.2.2. [Editing a module](#editing-a-module-edit) + 2.2.3. [Deleting a module](#deleting-a-module-delete) + 2.2.4. [Finding information about a module](#finding-information-about-a-module-info) + 2.3. [Calculating the total current CAP](#calculating-the-total-current-cap-calculatecap) + 2.4. [Calculating the total current Modular Credits (MCs)](#calculating-the-total-current-modular-credits-mcs-calculatemc) + 2.5. [Exiting the program](#exiting-the-program-exit) 3. [Advanced Use](#advanced-use) 3.1. [Editing the data file](#editing-the-data-file) 4. [FAQ](#faq) @@ -144,10 +142,9 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -**Note Box** - -The module code, module title, module description and modular credits **cannot** be edited. - +:information_source: **Note:** +The module code, module title, module description and modular credits **cannot** be edited. + In ModCraft, you can specify the **year, semester and grade** of each module when you are adding or editing your study plan. @@ -182,7 +179,7 @@ Currently, ModCraft have certain **limitations**. * ModCraft **does not** check for availability of modules for semesters. This means that you can add any module into any semester of your study plan, even though the module may not be offered in that semester. -* ModCraft **does not** check for the availability of Satisfactory/Unsatisfactory (S/U) options of modules, meaning that you can add a non-SUable module, for example `CS2100` and input its grade as `CS`. +* ModCraft **does not** check for the availability of Completed Satisfactory/Completed Unsatisfactory (CS/CU) options of modules, meaning that you can add a non-CS/CU module with a CS/CU grade, for example `CS2100` and input its grade as `CS`. Likewise, you can add a CS/CU module with a non-CS/CU grade. These features are planned enhancements in future releases. @@ -212,7 +209,7 @@ Below shows what ModCraft should look like for executing the `add` command. **Tip:** To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. -For **Satisfactory/Unsatisfactory (S/U)** modules, you can insert `CS` or `CU` as `GRADE`. +For **Satisfactory/Unsatisfactory (S/U)** modules, you can insert `S` or `U` as `GRADE`. @@ -227,8 +224,8 @@ Format: `edit MODULE [y/YEAR] [s/SEM] [g/GRADE]` Examples: * `edit CS2030S g/A+`: Updates the grade of CS2030S to A+. * `edit CS3230 y/4 s/2`: Moves CS3230 to the Year 4 Semester 2 module list. -* `edit CS2100 y/1`: Moves CS2100 to the Year 1 module list, with **Semester unchanged**. If before edit, the module was in Year 2 Semester 1, after edit it would be in Year 1 Semester 1. -* `edit CS2101 s/1`: Moves CS2101 to the Semester 1 module list, with **Year unchanged**. If before edit, the module was in Year 1 Semester 2, after edit it would be in Year 1 Semester 1. +* `edit CS2100 y/1`: Moves CS2100 to the Year 1 module list, with **Semester unchanged**. If before editing, the module was in Year 2 Semester 1, after editing it would be in Year 1 Semester 1. +* `edit CS2101 s/1`: Moves CS2101 to the Semester 1 module list, with **Year unchanged**. If before editing, the module was in Year 1 Semester 2, after editing it would be in Year 1 Semester 1. Below shows what ModCraft should look like for executing the `edit` command. The grade of `CS1101S` is being edited to C. @@ -262,12 +259,11 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command -**Note Box** - -If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. +:information_source: **Note:** +If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. - +
:exclamation: **Caution:** @@ -286,7 +282,7 @@ The **module code, modular credit and module description** of the module will be Format: `info MODULE` Examples: -* `info CS2019S` +* `info CS2109S` * `info CS1010` Below shows what ModCraft should look like for executing the `info` command. @@ -301,9 +297,9 @@ Below shows what ModCraft should look like for executing the `info` command. ### Calculating the total current CAP: `calculateCAP` You can calculate the total current CAP of all modules stored in all years and semesters. -ModCraft will be calculating using the formula: +ModCraft will calculate the CAP using the formula: -$\frac{\text{sum of all modules: (grade point of that module * Modular Credits of that module)}}{\text{total Modular Credits}}$. +$\Large\frac{\text{sum of all modules: (grade point of that module * Modular Credits of that module)}}{\text{total Modular Credits}}$. Displays a `float` of `0.0` $\leq$ value $\leq$ `5.0`. @@ -326,7 +322,7 @@ The result displayed by the `calculateCAP` command **does not include** the modu ### Calculating the total current Modular Credits (MCs): `CalculateMC` -You can calculate the total current Modular Credits (MCs) stored in all years and semesters. Displays a float which is the sum of all MCs. +You can calculate the total current Modular Credits (MCs) stored in all years and semesters using this command. ModCraft displays a float which is the sum of all MCs of modules in the module plan. Format: `calculateMC` From 820e4663101f0bccd9879b0c6b53f3851cc048c3 Mon Sep 17 00:00:00 2001 From: rocketninja7 Date: Thu, 9 Nov 2023 18:14:52 +0800 Subject: [PATCH 2/7] Fix consistency among boxes --- docs/UserGuide.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index dd2c454b433..17028ac162c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,9 +33,9 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour.
-:information_source: **Note:** +
:information_source: **Note:** Provides you with information that is useful to know. - +
-------------------------------------------------------------------------------------------------------------------- ## Table of Contents @@ -142,9 +142,9 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -:information_source: **Note:** +
:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited. - +
In ModCraft, you can specify the **year, semester and grade** of each module when you are adding or editing your study plan. @@ -205,13 +205,11 @@ Below shows what ModCraft should look like for executing the `add` command. After executing add command - - -**Tip:** To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. +
:bulb: **Tip:** +To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. For **Satisfactory/Unsatisfactory (S/U)** modules, you can insert `S` or `U` as `GRADE`. - - +

@@ -234,11 +232,9 @@ Below shows what ModCraft should look like for executing the `edit` command. The After executing edit command - - -**Tip:** You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). - - +
:bulb: **Tip:** +You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). +

@@ -259,11 +255,11 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command -:information_source: **Note:** +
:information_source: **Note:** If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. - +
:exclamation: **Caution:** From 64f962387b96c10f0dd5f6fb7576906b4e9025c6 Mon Sep 17 00:00:00 2001 From: rocketninja7 Date: Thu, 9 Nov 2023 22:49:17 +0800 Subject: [PATCH 3/7] Fix note box --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 17028ac162c..d4e211a5671 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,7 +33,7 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour.
-
:information_source: **Note:** +
:information_source: **Note:** Provides you with information that is useful to know.
@@ -142,7 +142,7 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -
:information_source: **Note:** +
:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited.
@@ -255,7 +255,7 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command
-
:information_source: **Note:** +
:information_source: **Note:** If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. From 4aebfa846dfe0b0feac88bba39e617f464679795 Mon Sep 17 00:00:00 2001 From: rocketninja7 <43843106+rocketninja7@users.noreply.github.com> Date: Thu, 9 Nov 2023 23:11:27 +0800 Subject: [PATCH 4/7] Revert "Fix note box" --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d4e211a5671..17028ac162c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,7 +33,7 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour.
-
:information_source: **Note:** +
:information_source: **Note:** Provides you with information that is useful to know.
@@ -142,7 +142,7 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -
:information_source: **Note:** +
:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited.
@@ -255,7 +255,7 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command
-
:information_source: **Note:** +
:information_source: **Note:** If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. From aa3a3717f553c9532860bc8be7af24b5c8eeb9bc Mon Sep 17 00:00:00 2001 From: rocketninja7 <43843106+rocketninja7@users.noreply.github.com> Date: Thu, 9 Nov 2023 23:11:55 +0800 Subject: [PATCH 5/7] Revert "Fix consistency among boxes" --- docs/UserGuide.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 17028ac162c..dd2c454b433 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,9 +33,9 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour.
-
:information_source: **Note:** +:information_source: **Note:** Provides you with information that is useful to know. -
+ -------------------------------------------------------------------------------------------------------------------- ## Table of Contents @@ -142,9 +142,9 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -
:information_source: **Note:** +:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited. -
+ In ModCraft, you can specify the **year, semester and grade** of each module when you are adding or editing your study plan. @@ -205,11 +205,13 @@ Below shows what ModCraft should look like for executing the `add` command. After executing add command
-
:bulb: **Tip:** -To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. + + +**Tip:** To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. For **Satisfactory/Unsatisfactory (S/U)** modules, you can insert `S` or `U` as `GRADE`. -
+ +
@@ -232,9 +234,11 @@ Below shows what ModCraft should look like for executing the `edit` command. The After executing edit command
-
:bulb: **Tip:** -You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). -
+ + +**Tip:** You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). + +
@@ -255,11 +259,11 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command
-
:information_source: **Note:** +:information_source: **Note:** If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. -
+
:exclamation: **Caution:** From 101e70af184b857a364a9a0a269eaeec8e8d7dc2 Mon Sep 17 00:00:00 2001 From: rocketninja7 Date: Thu, 9 Nov 2023 23:36:22 +0800 Subject: [PATCH 6/7] Fix note box --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d4e211a5671..38658d67c25 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -33,7 +33,7 @@ Tips in boxes like this contain information that may be helpful. Warnings in boxes like this contain information that are vital to the running of the application. Ensure that you take special note of these warnings to prevent unexpected behaviour.
-
:information_source: **Note:** +
:information_source: **Note:** Provides you with information that is useful to know.
@@ -142,7 +142,7 @@ Examples: * Module Description: `This course introduces the fundamentals of data structures and algorithms.` * Modular Credits: `4` -
:information_source: **Note:** +
:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited.
@@ -255,7 +255,7 @@ Below shows what ModCraft should look like for executing the `delete` command. T After executing delete command
-
:information_source: **Note:** +
:information_source: **Note:** If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. From e1aba108a64d158a0e8ee5331aebf1442aee1810 Mon Sep 17 00:00:00 2001 From: rocketninja7 Date: Thu, 9 Nov 2023 23:43:11 +0800 Subject: [PATCH 7/7] Fix other box issues --- docs/UserGuide.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a4ecfeec11e..7b6fd64baa5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -35,7 +35,7 @@ Warnings in boxes like this contain information that are vital to the running of
:information_source: **Note:** Provides you with information that is useful to know. - +
-------------------------------------------------------------------------------------------------------------------- ## Table of Contents @@ -144,7 +144,7 @@ Examples:
:information_source: **Note:** The module code, module title, module description and modular credits **cannot** be edited. - +
In ModCraft, you can specify the **year, semester and grade** of each module when you are adding or editing your study plan. @@ -205,13 +205,11 @@ Below shows what ModCraft should look like for executing the `add` command. After executing add command
- - -**Tip:** To **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. +
:bulb: **Tip:** +TTo **plan ahead** using ModCraft, you can input `IP` for grade to represent grade **in progress**. For **Satisfactory/Unsatisfactory (S/U)** modules, you can insert `S` or `U` as `GRADE`. - - +

@@ -234,11 +232,9 @@ Below shows what ModCraft should look like for executing the `edit` command. The After executing edit command
- - -**Tip:** You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). - - +
:bulb: **Tip:** +You need to provide at least one of the optional fields (either GRADE or YEAR or SEMESTER). +

@@ -263,7 +259,7 @@ Below shows what ModCraft should look like for executing the `delete` command. T If you are **dropping a module** and retaking it in later semesters, the module dropped should be **deleted** before adding the same module to another semester later on. ModCraft currently **does not support** retaking failed modules by keeping the failed module in the study plan and adding another copy of the same module for retake. - +
:exclamation: **Caution:**