search

LamJiuFong / pe

0 stars 0 forks source link

Diagram is not compliant with those taught in class #6

Open LamJiuFong opened 9 months ago

LamJiuFong commented 9 months ago

Screenshot 2023-11-17 at 5.29.06 PM.png

For the diagram above, it used a notation not taught in class which are the "Arguments provided?" and "Matches found?" boxes.

I think they can be represented using empty diamonds and put [arguments provided] [matches found] [else] as the condition right above the lines.

nus-pe-bot commented 9 months ago

Team's Response

I agree. I referred to a different source, and it differs from that in the CS2103 Website.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I think this should be of severity.Low because I believe that it causes minor inconvenience to readers since new notations are added and they have to figure out what does it mean or think about whether they have special meanings.

Also, since using notations not taught in class is considered a valid bug as stated in the website, I believe that this DG is meant to be read by people who follow the notations in CS2103T, and the inconsistency between what is taught in class and what is presented in the DG might confuse some people and cause minor inconvenience.

Furthermore, the developer team did not justify their decision on rejecting severity.Low and choosing severity.veryLow. I dont think this is a cosmetic issue since it introduces confusion to the readers