[CS2103T-W17-1] FlashSpeed #40
Conversation
artlee06
left a comment
artlee06
left a comment
There was a problem hiding this comment.
Good Effort guys! Refer to the comments made for some suggestions on what we think could improve your Developer Guide. Also consider having a variety of diagrams instead of just sequence diagrams.
|
|
||
| *API* : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`] | ||
|
|
||
| The `Model`, |
There was a problem hiding this comment.
Figure 7 is a pretty good diagram, but some things to take note. Consider the 2 arrows pointing to UniqueCardList, the two 1s initially confused us as being 11 so it might be better if you separate them a little more. Also, we would love it if the diagram was smaller. Cheers!
docs/DeveloperGuide.adoc
Outdated
|
|
||
| The following sequence diagram shows how the `flip` operation works. | ||
|
|
||
| image::FLipSequenceDiagram.png[] |
There was a problem hiding this comment.
This image does not render, perhaps you missed something? Fix it soon, okay? :)
|
|
||
| The following sequence diagram shows how the `play` operation works. | ||
|
|
||
| image::PlaySequenceDiagram.png[] |
There was a problem hiding this comment.
This sequence diagram and the subsequent sequence diagrams refer to their returned Command sub objects as "e". We think it should correspond to the first alphabet of the name of the subclass.
Also the rightmost "e" under the Model box is a little ambiguous as what it refers to. Perhaps the GameManager instance. Regardless please reflect it on the next iteration of the diagram.
Also it is unclear as to where commandResult is instantiated. Consider showing where it is being in constructed.
For your consideration. Cheers!
JUnit-library
Update DG architecture and card edit
Add language support, command table
Junit for mainly command classes and some testutils
Update tests for ParserUtil
LogicManager-Test
Remove unused
Fix parser util tests
Update kschiew portfolio
fix broken link
Remove unused files
update-file
Final Touchup
Final docs
6 participants
@amrl
@kschiew
@lacedaemon98
@oLiXino