[CS2113T-W12-4] Plan&Score#81
Conversation
jialerk
left a comment
jialerk
left a comment
There was a problem hiding this comment.
Overall good job, you seem to have a lot of diagrams for your develop guide :)
|
|
||
|  | ||
|
|
||
| Figure 9. Sequence Diagram of the writing of data |
There was a problem hiding this comment.
Maybe there might be an activation bar when you arrow back to your ControlManager
|
|
||
|  | ||
|
|
||
| Figure 10. Sequence Diagram of the reading of data |
There was a problem hiding this comment.
Maybe there might be an activation bar when you arrow back to your QuizListDecoder
|
|
||
|  | ||
|
|
||
| Figure 4. Class Diagram of the Model component |
There was a problem hiding this comment.
Maybe you can extend the dotted arrow from ModelManager to Interactable
The EventManager Implementing from interface might be a dotted arrow instead
| <br /> | ||
|
|
||
| #### Storage component | ||
|  |
There was a problem hiding this comment.
Is StorageManager an interface? why are there dotted arrows pointing towards it
| Each `StorageManager` reads in their respective data files through a `decoder` and writes to the same file through an `encoder` | ||
|
|
||
| ##### Event Storage | ||
|  |
There was a problem hiding this comment.
Maybe your arrow for inheritance is pointed in the wrong direction
maybe you can add an association label for creates
hui444
left a comment
hui444
left a comment
There was a problem hiding this comment.
Good job on your DG! :)
However, do check your return arrows for the activation bar as many of your diagrams missed it.
|
|
||
| It returns an `EventParameter` to `EventStorageManager`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Should there be a return arrow for the end of the activation bar in EventListDecoder (its self invocation)?
Consider adding an activation bar for EventStorageManager to keep the diagram consistent.
|
|
||
| It returns a `String` to `EventStorageManager` for further writing. | ||
|
|
||
|  |
There was a problem hiding this comment.
Should there be a return arrow for EventStorageManager?
Consider adding an activation bar for EventStorageManager to keep the diagram consistent.
|
|
||
| Figure 9. Sequence Diagram of the writing of data | ||
|
|
||
|  |
There was a problem hiding this comment.
Should decodeQuizFromString be written as decodeQuizFromString()?
|
|
||
| #### Model component | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the arrow pointing to the interface be a dotted line arrow?
|
|
||
| #### Model component | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this arrow too short? It is hard to see whether it is a solid line arrow or a dashed line arrow.
|
|
||
| #### List event (<date> / today) | ||
|
|
||
|  |
There was a problem hiding this comment.
Is "str" not descriptive?
Do you mean "printableEvents" or at least "string" ?
|
|
||
| It returns an `EventParameter` to `EventStorageManager`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Maybe there can be an avtivation bar here.
|
|
||
| #### List event (<date> / today) | ||
|
|
||
|  |
There was a problem hiding this comment.
Maybe there can be a return arrow here.
pinfang
left a comment
pinfang
left a comment
There was a problem hiding this comment.
some sequence diagrams are missing activation bars
|
|
||
| #### Model component | ||
|
|
||
|  |
There was a problem hiding this comment.
can try to re-position the arrows so that the arrows are not covering the words or overlapping?
|
|
||
| It returns an `EventParameter` to `EventStorageManager`. | ||
|
|
||
|  |
There was a problem hiding this comment.
does the part highlighted in yellow included in sequence diagram?
and the part circled in red, does the activation bar end?
|
|
||
| ### Help feature | ||
|
|
||
|  |
There was a problem hiding this comment.
should there be a return arrow (the part i circled) ?
and for showToUser(), should it be inside the handleHelp()?
|
|
||
| ### Add feature | ||
|
|
||
|  |
There was a problem hiding this comment.
i could not find DataManager class in your code, i only see EventDataManager. is the naming of the class in the diagram correct?
Update images, github link and PPP link
…into branch-update-dg # Conflicts: # docs/AboutUs.md
Update developer guide UML diagrams
Update user guide
Update User Guide (Handle indentation of command 14)
Update QuizManager.java (Assertions)
Edit DG Quiz Feature (improve readability)
…ception Branch storage corrupted exception
Relocate unused file (QuizManager)
…into Update-UserGuide � Conflicts: � docs/UserGuide.md
Added more images and updated the userguide
Refine ppp & Fixed UG hyperlink
Update PPP, UG and DG authorship
…into branch-PPP # Conflicts: # docs/DeveloperGuide.md
…into branch-PPP # Conflicts: # docs/DeveloperGuide.md # docs/UserGuide.md
Add in authorship for dg and ug
Update ug dg
…into update-UserStories � Conflicts: � docs/DeveloperGuide.md
Branch developer guide
Update user stories
Update factory reset message
Update UserGuide.md
updated links
9 participants
Plan&Score is a Java command-line application that allows Primary 6 students to plan and track their classes, CCAs and test dates. This enables the students to remember their schedule so they can plan well in advance for their tests and score better.