Alvinlj00 / pe

0 stars 0 forks source link

Implementation sequence diagrams can be simpler #15

Open Alvinlj00 opened 2 years ago

Alvinlj00 commented 2 years ago

The sequence diagrams in the implementation section are thorough but can be made simpler such that readers know the main sequence of processes when a command is detected.

nus-pe-script commented 2 years ago

Team's Response

The issue reported is very broad without any specific diagram indicated. Even if the diagrams may be a little complicated, we still displayed accurate diagrams which incorporated all major method calls of our code so as to enhance comprehensability. Likewise, we have also discarded the display of trivial methods in our diagrams to downscale the complexity, so we did not put all methods when we thought that they did not value add to our diagrams. (eg. all methods from the Validate class were not displayed)

Therefore, we have also downgraded the bug to Low since the diagrams are still understandable for most developers.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: [replace this with your explanation]


:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]