[CS2113T-F11-2] CEGMods #51
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yeapcl
pushed a commit
to yeapcl/tp
that referenced
this pull request
Oct 14, 2020
updated test cases
Improve code quality
Add Ui, printWelcomeMessage, and printHelpMessage
add ui,welcome,help
add ProjectTask and ProjectManager
edit task class,tasklist,timetable and add storage
edit javadoc
add api, change module, timetable need change
QX-CHEN
reviewed
Oct 28, 2020
docs/DeveloperGuide.md
Outdated
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Perhaps there should be a Command class handling the operations like print, add and delete, instead handled by Parser class?
QX-CHEN
reviewed
Oct 28, 2020
docs/DeveloperGuide.md
Outdated
| The user type in command in `module mod/<MODULE_CODE> lec/<LECTURE_DAY> <LECTURE_TIME> tut/<TUTORIAL_DAY> <TUTORIAL_TIME> lab/<LAB_DAY> <LAB_TIME>` this form to add a module into the timetable. The time slot of lab is optional. The program will detect whether the user command is in this form, and store module data in arraylist `modules` in `Timetable` class after Ui passing command and calling `addModule()` in Parser class. | ||
|
|
||
| The ***sequence diagram*** below shows the interaction between these classes when the user adds a module. | ||
| [](https://freeimage.host/i/3GRaM7) |
There was a problem hiding this comment.
Consider reaplacing the input from user to ui with the actual input, instead of "add a module".
QX-CHEN
reviewed
Oct 28, 2020
docs/DeveloperGuide.md
Outdated
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Storage class is missing from the architecture diagram, or the app data not stored?
QX-CHEN
reviewed
Oct 28, 2020
docs/DeveloperGuide.md
Outdated
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Perhaps could combine Timetable, Module and Task into a data model component?
QX-CHEN
reviewed
Oct 28, 2020
| {Describe the value proposition: what problem does it solve?} | ||
| ## 2. Setting up and getting started | ||
| Setting up the project in your computer | ||
| > <font color=#FF5733>Caution: </font> <font color=#00000><font color=#00000> **Please follow each steps in the guide carefully.** </font> |
There was a problem hiding this comment.
Caution and Note are not displaying properly.
QX-CHEN
reviewed
Oct 28, 2020
| The `Timetable` class shows the timetable for all the module slots and tasks. It also stores `Module` details in an arraylist and checks whether there is a time conflict between two classes. | ||
|
|
||
|
|
||
| ## 4. Implementation |
There was a problem hiding this comment.
Can add a few more UML diagram for Design and Implementation.
QX-CHEN
reviewed
Oct 28, 2020
Edit spacing for PPP
update help feature
update PPP
…into UG_2101Formatting * 'master' of https://github.com/AY2021S1-CS2113T-F11-2/tp: (23 commits) Update AboutUs.md Update AboutUs.md Update AboutUs.md update PPP Add files via upload Create image update help feature Update AboutUs.md Update AboutUs.md add author Update DeveloperGuide.md rename PPP update DG add protfolio Rename docs/zhangcaicai123.md to docs/team/zhangcaicai123.md Update zhangcaicai123.md add zhang danrui's PPP update DG, fix superlinks fix project task bug update readme file ... # Conflicts: # docs/DeveloperGuide.md # docs/UserGuide.md
Ug 2101 formatting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CEGMods is a time scheduler app that manage different issues and tasks which is optimized for CEG students. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands