search

spinoandraptos / pe

0 stars 0 forks source link

Non-standard notation UML (snon-standard #12

Open spinoandraptos opened 8 months ago

spinoandraptos commented 8 months ago

image.png

Should use + and - for visibility under standard notation like below

image.png

nus-pe-bot commented 8 months ago

Team's Response

duplicate of 1011 regarding private/public indicator

The 'Original' Bug

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

Main class diagram does not follow specification

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.

image.png

Missing public/private indicators

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

Their Response to the 'Original' Bug

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

Adding of public/private indicators will indeed make it easier for the developers, when they want to know how the program works

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: This is not a duplicate issue as the 'original' bug is about the public/private indicators being completely missing from the class diagram whereas my issue is about the public/private indicators being present in the diagram but marked using wrong notations. These 2 should be classified as separate bugs. In addition, the 2 bugs do not even refer to the same class diagram.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/spinoandraptos/pe/main/files/da8e9407-b514-4b6d-9793-5a60d99c75a0.png) ------ This non-standard notation for visibility in the class diagram can lead to confusion among readers and future developers trained under the standard notation who will have to waste unnecessary time browsing through the entire codebase to understand whether the red squares and green circles mean public or private. No legend was provided to offer guidance as well. Thus the bug is not purely cosmetic as it affects the development work of future developers by introducing unnecessary hindrance.