search

wanghejin / pe

0 stars 0 forks source link

Incorrect arrow direction in UML #18

Open wanghejin opened 9 months ago

wanghejin commented 9 months ago

I believe the arrow should point downwards here, to the superclass.

image.png

image.png

nus-se-bot commented 9 months ago

Team's Response

Hi I am the dev responsible for this issue, thanks for the report! I do agree with you that it is a documentation bug, and it is indeed my mistake for poor QC in updating the PUML diagrams. However I believe that the mistake is obvious enough that the reader should be able to figure out from context that the arrows are evidently pointing the wrong way (e.g. the BuyerCard obviously cannot be a dependency of the abstract PersonCard). Hence I have downgraded it to Severity.Low. Let me know what you think.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Incorrect class diagram

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Screenshot 2023-11-17 at 5.15.13 PM.png

This diagram implies that the Displayable class inherits from UniqueDisplayableList<? extends Displayable>, which is intuitively illogical. The relationship between both classes should be contains instead if there is to be any relationship between the two.

[original: nus-cs2103-AY2324S1/pe-interim#2537] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Hi thank you for the report. I am the dev responsible; this is a mistake on my part and I thank you for reporting it. We should have done more QC in regards to the updating of older PUML diagrams. Nevertheless, I hope the meaning is clear enough from the context. Accepted!

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Hi I would like to downgrade this `severity.Low`. I disagree with choosing `VeryLow` because only cosmetic issues (which are not inherently wrong) can choose this severity. However, here the UML is clearly wrong, with multiple diagrams having the same error. Hence, I believe a Low severity suffices.