search

rui-han-crh / pe

0 stars 0 forks source link

DG Diagram in Remove Applicants is Too Compact #8

Open rui-han-crh opened 2 years ago

rui-han-crh commented 2 years ago

Description

The DG contains a diagram with an activation bar that is too short for all the information within. This causes the text to be too close to each other.

image.png

It is not clear in this section if confirmRemove() is something self-invoked, or something that is being returned.

In this case, the return arrow of the self invoked function would have been better omitted and the activation bar lengthened.

Justification for Severity: Low

In the worse case, the user does not understand clearly what is being returned. In the best case, the user may read the code itself to check, but that may defeat the point of having the DG.

nus-pe-script commented 2 years ago

Team's Response

Justification for downgrade from severity.Low to severity.VeryLow:

The team acknowledge this mistake in the developer guide, but this does not severely undermine the functionality of TrackAScholar. Given that this is only a cosmetic issue, our team would like to rate this as a VeryLow severity issue.

image.png

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]