search

cowlinn / pe

0 stars 0 forks source link

Missing Labels for diagram #15

Open cowlinn opened 2 years ago

cowlinn commented 2 years ago

image.png

image.png

Under Review Editting, a UML diagram was added. But there was no reference or explanations accompanying the diagram

nus-se-bot commented 2 years ago

Team's Response

The explanation is provided before the image.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: I agree that there was an explanation explaining the function. But I'm not sure if this can be considered as severity.VeryLow because it's not just a cosmetic issue, and there's some missing elaboration. But to what extend is elaboration required? I think whoever's marking can make by asking him/herself the following:

If the DG included a one-liner above the diagram mentioning something like: "The diagram below explains how the parser handles an editReview function", is this considered complete labelling / reference to the diagram?

If so, then I think it's perfectly acceptable as a cosmetic issue, and hence can be considered veryLow.

I submitted this as a bug mainly because my team tried to add in-text references explaining what happens for each diagram, but technically I can't find any information in the textbook explicitly mentioning that this is a bug, other than minor inconveniences affecting readability.