ngkaiwen123 / pe

0 stars 0 forks source link

Wrong labelling for methods and attributes in the Class Diagrams #6

Open ngkaiwen123 opened 1 year ago

ngkaiwen123 commented 1 year ago

Class Diagrams found in the DG do not follow the correct labelling. "+" and "-" should be used instead of icons.

image.png

nus-pe-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Developer Guide Diagnosis class diagram does not follow standard notation

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

As shown in the requirements, standard notation needs to be used such as + for public and - for private. Also the labelling of Enum is missing

image.png


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

Their Response to the 'Original' Bug

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

We accept this as we actually changed the UML code to remove the icons but did not save a new image. However, this is not a Low severity and is instead VeryLow as it is purely cosmetic.

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.Low`] - [x] I disagree **Reason for disagreement:** It is not purely cosmetic, and hence `severity.Low` is a better fit. An example can be seen from the `Diagnosis` class. It is unknown what the icons really meant for the red filled box, green filled circle and red outlined box. If there was a legend somewhere, then it may have been a `severity.VeryLow` issue. ![3cb38080-522f-4353-9709-9dde17677ddd.png](https://raw.githubusercontent.com/ngkaiwen123/pe/main/files/b3302878-e675-42b0-990e-14da0e05ed5c.png)