RyanQiu1 / pe

0 stars 0 forks source link

Unclear notation and diagram #14

Open RyanQiu1 opened 1 year ago

RyanQiu1 commented 1 year ago

Not sure if this is an object diagram or class diagram as it seems to have both elements in it. Could be clearer to state. The red squares also do not seem to be in the notation provided by the module.

image.png

nus-se-script commented 1 year ago

Team's Response

This is a class diagram, as there is no : before the class name as shown in the diagram. I assumed that 'it seems to have both elements in it' means there are fields inside the diagram. But the class diagram allows fields inside the diagram.

We will change the notations accordingly for private fields.

(Reference)

The 'Original' Bug

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

[Cosmetic bugs] Model - UniqueScoreList Model

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.


Red boxes apparent in the UML diagram for private fields

Screenshot 2023-04-14 at 3.25.23 PM.png


[original: nus-cs2103-AY2223S2/pe-interim#1930] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

Noted, however we do not think this is a high severity bug as it would not hinder the reader to a large extent.

(Reference)

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