search

nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

Attribute and association arrow both added in DeveloperGuide #543

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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 the RecipeList Component, some attributes are already listed in the attribute section of the class diagram, but yet the association arrow is still drawn:

image.png

For instance, IngredientList is already specified as an attribute in Recipe, however the association arrow to IngredientList is still drawn.

This is a mistake in UML notation since the module website dictates that we either specify as attributes in the class diagram, or we draw the association arrow, but not both. This mistake is not just cosmetic, but wrong use of notation, so it's not VeryLow severity.

Plus, other sections like Storage Component also makes this same mistake, so the severity is not just Low since it's not a mistake made once in the DeveloperGuide(in just one section).

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

Aung-Phone-Naing commented 1 year ago

Team's Response

Agree with the bug as this is a lapse on the team's part, however this does not severly affect the understanding of the diagram hence the justification for Low.

Duplicate status (if any):

--