nus-pe-bot
commented
2 years ago Team's Response
Duplicate because both issues describe the lack of diagrams under the Implementation section of the DG.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Diagrams for Implementation in DG
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
I felt like most of the diagrams are put in the design architecture. While it makes sense, as a developer, I would also like to see how the implementation works in visual. I find this quite lacking in the DG, which is why I think it should be a good idea to add more UML diagram on this part of the implementation.
[original: nus-cs2103-AY2122S1/pe-interim#4368] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
This bug report sounds more like a suggestion. The lack of UML diagrams do not hinder the understanding of the reader because the contents are complete and can be understood. Hence, the severity should be Low.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue severity
Team chose [severity.Low]
Originally [severity.VeryLow]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
An UML sequence diagram can be used to better illustrate the flow and visualise how the components work to execute the filter command. As of now, readers may not be able to visualise how the command is executed, due to no UML diagrams provided.