Update feature descriptions and images for UG, Add Intro for DG and update HelpCommand #70
Conversation
…pdate HelpCommand
yan-soon
added
documentation
docs/UserGuide.md
Outdated
| Description: | ||
|
|
||
| * Adds any Module of choice into the list of Current Modules in GradPad. | ||
|
|
||
| * User can add any module by specifying their desired Module Code (eg. CS1231), | ||
| Modular Credits (eg. 4), and Tags (eg. Core) along with the `add` command, in their | ||
| input. | ||
|
|
||
| * Module Code and Modular Credit fields are compulsory inputs but Tag fields are optional. | ||
| Multiple Tags are allowed per module. |
There was a problem hiding this comment.
maybe can include that the add command prevents duplicate modules from being created? actually right.... as of now our application allows duplicates if they are not completely equal, should we address that?
docs/UserGuide.md
Outdated
|
|
||
| * Edits the module details of a module that has already been added to GradPad. |
There was a problem hiding this comment.
very minor nit: perhaps "Edit the details of a module...." would be better? 😅
oh! and also, i thought we were changing edit to edit {module code} instead of edit {index}? 😕
There was a problem hiding this comment.
Changed the structuring! For the edit {index}, I decided to keep it as {index} for now to match the expected outcome images! I can change it accordingly once we have updated our code
| Exits the program. There is no auto-save upon exit. | ||
| Description: | ||
|
|
||
| * Exits GradPad. All changes made while on GradPad will be saved automatically. |
There was a problem hiding this comment.
i think might not be necessary to mention the save part cause if im not wrong the exit command doesn't do a final save before exiting 😄
There was a problem hiding this comment.
Not too sure as well, was kinda going for the notion that saving would be done automatically throughout usage of the app, cause I realise we didnt mention anything about saving throughout, and I thought people might think of saving when they think of exiting HAHAHA
There was a problem hiding this comment.
HAHAHAHA true true true...... then either we stick with this or we must include the 'auto-save' in the other features ah
Codecov Report
@@ Coverage Diff @@
## master #70 +/- ##
=========================================
Coverage 75.00% 75.00%
Complexity 423 423
=========================================
Files 75 75
Lines 1244 1244
Branches 122 122
=========================================
Hits 933 933
Misses 273 273
Partials 38 38
Continue to review full report at Codecov.
|
UG
DG
HelpCommand