mukund1403 / pe

0 stars 0 forks source link

Incorrect use of symbols for class names in UI package class diagram #12

Open mukund1403 opened 5 months ago

mukund1403 commented 5 months ago

The class diagram uses symbols in front of the class name which are not required according to CS2113 class diagram guidelines.

image.png

The way a class should be drawn:

image.png

soc-pe-bot commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Symbols for visibility incorrect for UI package 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.


The symbols used for the visibility are not in line with the CS2113 guidelines. This could be a severity.medium because another developer from the CS2113 cohort reading the DG may not understand what the visibility of the attributes or methods are.

image.png

Example of visibilities shown:

image.png


[original: nus-cs2113-AY2324S2/pe-interim#916] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]