[CS2113-T15-3] Module Manager #27
Conversation
RenzoTsai
changed the title
Fix issues to pass CL test.
| 2) Added using `add id/ID s/SEMESTER mc/MODULE_CREDIT` command | ||
|
|
||
| Step 2: | ||
| User executes `CAP` command to view his own CAP. The `CAP` commands is parsed through `Parser`, which would then return |
There was a problem hiding this comment.
Some remarks to the Calculate CAP operation sequence diagram.
docs/DeveloperGuide.md
Outdated
| The user launches the application for the first time. The `SemesterList` will be initialized with the none | ||
| `SemModulesList` in it. |
There was a problem hiding this comment.
Do you mean to say "empty SemModulesList"?
docs/DeveloperGuide.md
Outdated
| `AddToSemCommand#execute()` then calls self method `AddToSemCommand#addModule()`.`AddToSemCommand#addModule()` | ||
| then calls `AddToSemCommand#checkModuleExist(semesterList)` to check whether the selected | ||
| module is already in the selected module list (i.e:`semesterList`, which is a `PriorityQueue<SemModulesList>`). | ||
| If the module is not in the list, `AddToSemCommand#addModule()` will check whether there is a semester list | ||
| (i.e:`semesterModulesList`, which is a `ArrayList<SelectedModule>`) whose name is the module's semester name. | ||
| If the semester list exist, the module will be added to the list. | ||
| If not, `AddToSemCommand#addModule()` will create a new semester list and then add this module to the new list. and the | ||
| the new semester list will be added to `semesterList` as well. |
There was a problem hiding this comment.
I found this section quite confusing to read as there are a few variables and classes with similar names (semesterList, SemModulesList, semesterModulesList, SemesterList), and the multiple 'if' condition checks. Perhaps it would help to briefly explain the connection between semesterList and semesterModulesList, at the very beginning, before delving into the logic? I.e. "semesterList represents XXX and stores instances of SemModuleList. semesterModulesList represents XXX and stores XXX"
docs/DeveloperGuide.md
Outdated
| user | ||
|
|
||
| The following sequence diagram shows how the `Add to Semester` operation works: | ||
|  |
There was a problem hiding this comment.
Some comments on the sequence diagram
There was a problem hiding this comment.
On a side note, the diagram doesn't show up properly when I load the website, and stays like this when I refresh. I had to right click the icon and open in a new tab to view it. Could there be a problem with the file linking?
| with a pattern of `#.00`. `Ui.showcap(cap)` is called to display the user's cap using the formatted `String`. | ||
|
|
||
| The following diagram shows how the Calculate CAP operation works: | ||
|  |
There was a problem hiding this comment.
I agree with what Isabella said about the construction of CalculateCapCommand. Otherwise it looks good to me. Perhaps you may want to specify the return value (grade) of the getGrade() method to be consistent, as you did so for totalCap?
docs/DeveloperGuide.md
Outdated
| user | ||
|
|
||
| The following sequence diagram shows how the `Add to Semester` operation works: | ||
|  |
There was a problem hiding this comment.
Can it be the case that steps also refer tot the Sequence Diagram while explaining the Add To Semester feature?
|
|
||
| Step 2: | ||
| User executes `CAP` command to view his own CAP. The `CAP` commands is parsed through `Parser`, which would then return | ||
| `CalculateCapCommand()`. `CalculateCapCommand.execute()` is then called. |
There was a problem hiding this comment.
I am wondering if it is fully clear weather object representing CalculateCapCommand class or a Person Object Calculates the total cap. More specifically, the setTotalCap() method and getTotalCap() methods are pointed in the same direction, so I wasn't a 100% sure from the diagram where the CAP calculation was happening.
docs/DeveloperGuide.md
Outdated
| The `Model` component | ||
| * Stores a `Person` object that represents the user's details. (e.g. `totalCap`, `totalModuleCreditCompleted`) | ||
| * Stores the `ModuleList` and `SemesterList` Data | ||
| * Does not depend on any of the other three components |
There was a problem hiding this comment.
I was wondering if Model component is not related to other three components, then how would a Person object, which is stored in Model Component, have their CAP calculated? Maybe "does not depend" is not the correct phrase here?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Implementation | ||
|
|
||
| #### `Add to Semester` feature |
There was a problem hiding this comment.
The diagram looks very neat and helps the developer understand the basic logic of add to semester future. So perhaps, is the explanation repetitive here?
Fix some bugs
…r credits and semester values
Updated Developer Guide
Allow to show prerequisites which are not in the available modules list and fix a bug when add same modules to AML
Updated Developer Guide and Architecture.png
Updated DG with design consideration for Mark As Done
Added Viewing in DG and design considerations
Update Benny's PPP
Add design considerations
Update add‘s design consideration in DG
updated deetomok.md
Added table for Design consideration
updated deetomok.md
update AboutUs.md
update deetomok.md
update deetomok.md
update UG
@bennychanya @chengTzeNing @DeetoMok