Skip to content

[CS2113T-F11-2] CEGMods#51

Open
gy716 wants to merge 306 commits into
nus-cs2113-AY2021S1:masterfrom
AY2021S1-CS2113T-F11-2:master
Open

[CS2113T-F11-2] CEGMods#51
gy716 wants to merge 306 commits into
nus-cs2113-AY2021S1:masterfrom
AY2021S1-CS2113T-F11-2:master

Conversation

@gy716

@gy716 gy716 commented Oct 2, 2020

Copy link
Copy Markdown

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

yeapcl pushed a commit to yeapcl/tp that referenced this pull request Oct 14, 2020
Comment thread 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.
[![Architecture diagram](https://iili.io/3Ei2Vf.md.png)](https://freeimage.host/i/3Ei2Vf)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps there should be a Command class handling the operations like print, add and delete, instead handled by Parser class?

Comment thread 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.
[![3GRaM7.md.png](https://iili.io/3GRaM7.md.png)](https://freeimage.host/i/3GRaM7)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider reaplacing the input from user to ui with the actual input, instead of "add a module".

Comment thread 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.
[![Architecture diagram](https://iili.io/3Ei2Vf.md.png)](https://freeimage.host/i/3Ei2Vf)

@QX-CHEN QX-CHEN Oct 28, 2020

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Storage class is missing from the architecture diagram, or the app data not stored?

Comment thread 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.
[![Architecture diagram](https://iili.io/3Ei2Vf.md.png)](https://freeimage.host/i/3Ei2Vf)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps could combine Timetable, Module and Task into a data model component?

Comment thread docs/DeveloperGuide.md
{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>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution and Note are not displaying properly.

Comment thread docs/DeveloperGuide.md
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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can add a few more UML diagram for Design and Implementation.

@QX-CHEN QX-CHEN left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally, more details can be added to design and implementation.

NAOMI\lemonhyuuga and others added 30 commits November 9, 2020 23:30
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants