search

YoYoCiti / pe

0 stars 0 forks source link

Lacking Diagrams in Implementation #9

Open YoYoCiti opened 2 years ago

YoYoCiti commented 2 years ago

Description: There are implementation details in the Implementation Section that lack use of diagrams that could be appropriate in supplementing the given explanations.

image.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I do not agree that the severity should be of Very Low. The omission of diagrams to supplement the explanations is not merely a cosmetic issue. Diagrams are meant to help the reader better understand the implementation details, and the complete lack thereof in two of the sections would definitely cause a minor inconvenience to the readers, as they would have to instead navigate and analyze the code to get a visual representation of the explanations. Thus, severity of Low is most appropriate.