search

SeeuSim / pe

0 stars 0 forks source link

DG Command Sequence Diagram too small, not consistent #15

Open SeeuSim opened 1 year ago

SeeuSim commented 1 year ago

In addition to being small and hard to read, the formatting/styling is also not consistent with earlier diagrams

Screenshot 2023-04-14 at 2.54.20 PM.png

Earlier Diagram:

Screenshot 2023-04-14 at 2.55.51 PM.png

soc-pe-bot commented 1 year ago

Team's Response

The formatting/styling is not consistent because the former one is a sequence diagram while the latter one is a class diagram.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This is a cosmetic flaw, as upon inspecting the codebase and versioning, they re-generated this new sequence diagram using the same stylesheets, but there are still some visual inconsistencies.

This could be because the diagrams were generated on different software/devices, and hence led to the inconsistency/visual discontinuity of the guide. Also, this could be because the previous class diagram was not regenerated.

Furthermore, the small size makes it hard to read on low-resolution displays and a cosmetic flaw at best, but a documentation bug at worst.

Thus, this warrants a Documentation Bug of at least a Very Low severity.