purivirakarin / pe

0 stars 0 forks source link

DG: Incorrect ModelDiagram on Page 7 #8

Open purivirakarin opened 4 months ago

purivirakarin commented 4 months ago

As per the first screenshot given, Remark red box is located out of Model area which is not supposed to be as, referring to the second picture, the Remark class was under Model directory.

Screenshot 2567-04-19 at 17.16.36.png Screenshot 2567-04-19 at 17.16.43.png

nus-se-bot commented 4 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]

Incorrect UML 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.


In this diagram:

image.png

I think the Remark attribute should be inside the Model.


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

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.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I have identified an inconsistency between the model diagram on page 7 and the actual structure in the code repository. The 'Remark' class is misplaced in the diagram. This issue has been classified as Low severity since it may cause minor confusion when reading the documentation but does not impact the product's functionality. This type of flaw is not cosmetic since it affects the accuracy of the documentation and may lead to misunderstandings about the code structure, but it does not affect the functionality of the product itself.