[CS2103T-W17-2] Notably #29
Conversation
kevinputera
force-pushed
the
master
branch
2 times, most recently
from
b94eb02 to
7375cf0
Compare
| [TIP] | ||
| The `.puml` files used to create diagrams in this document can be found in the link:{repoURL}/docs/diagrams/[diagrams] folder. | ||
| Refer to the <<UsingPlantUml#, Using PlantUML guide>> to learn how to create and edit diagrams. | ||
|
|
||
| [[Design-Architecture]] | ||
| === Architecture | ||
|
|
||
| .Architecture Diagram | ||
| image::ArchitectureDiagram.png[] | ||
|
|
There was a problem hiding this comment.
Intuitive architecture diagram, however possibly a little too detailed. Consider only showing high-level details so it is clearer for developers.
| .Structure of the Logic Component | ||
| image::LogicClassDiagram.png[] | ||
| .Architecture of Logic | ||
| image::LogicArchitectureDiagram.png[] |
There was a problem hiding this comment.
Cool diagram! However, some features of a class diagram are present (dotted arrows, aggregation). Since it is a architecture diagram, it is not clear what they mean. Again, aim to capture high-level details in architecture diagrams. Unless you meant to make it a class diagram, where you would need to add more details and clarity. Maybe referring to AB3 architecture diagrams will be helpful.
| ==== CorrectionEngine component | ||
|
|
||
| .Class Diagram of the CorrectionEngine Component | ||
| image::CorrectionEngineClassDiagram.png[] |
There was a problem hiding this comment.
The interactions between CorrectionEngine to CorrectionStatus and CorrectionResult are not explained and cannot be inferred from the diagram. Maybe some clarification would be useful for developers to understand this.
|
|
||
| .Interactions Inside the Logic Component for the `delete 1` Command | ||
| [[Design-NotablyParser]] |
There was a problem hiding this comment.
No info on the NotablyParser component, maybe a mislabelling of the section?
| [TIP] | ||
| The `.puml` files used to create diagrams in this document can be found in the link:{repoURL}/docs/diagrams/[diagrams] folder. | ||
| Refer to the <<UsingPlantUml#, Using PlantUML guide>> to learn how to create and edit diagrams. | ||
|
|
||
| [[Design-Architecture]] | ||
| === Architecture | ||
|
|
||
| .Architecture Diagram |
There was a problem hiding this comment.
Would be good if the architecture diagram was used straight lines instead of curved ones, so that the diagram is less confusing.
There was a problem hiding this comment.
The architecture diagram seems a bit confusing. Could draw clearer where the commons is coming from! Otherwise, the architecture diagram seems to have been refactored greatly, keep up the hard work!
|
|
||
| .Structure of the UI Component | ||
| .Structure of the View Component |
There was a problem hiding this comment.
The lines pointing from SuggestionsList, SideBarTree and BlockContent seem very congested and they overlap a lot, making it seem confusing. Can try to separate them!
|
|
||
| .Interactions inside the StringCorrectionEngine component for the `correct("uncorrected")` call | ||
| image::StringCorrectionEngineSequenceDiagram.png[] | ||
|
|
||
| [[Design-Model]] | ||
| === Model component | ||
|
|
||
| .Structure of the Model Component |
There was a problem hiding this comment.
Do you intend for the relationship between BlockTree and BlockTreeItem to be composition?
Add logging to suggestions
…manshuGandhi/main into enhancement-help-text-command
DG manual testing
Add seq diagram for DG data structure section
Enable Root Open
Jia Zheng's PPP
Johanna's PPP
add link to notably.jar
Enhance DG [Hemanshu]
@firzanarmani
@HemanshuGandhi
@johannagwan
@ljiazh3ng
@kevinputera