search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Class Diagram format notation mistake #1824

Open nus-se-script opened 2 months ago

nus-se-script commented 2 months 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.

image.png The number should be on the up and down side of the line. The mistake raised probably when output the picture.

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

yeozhishen commented 2 months ago

Team's Response

There is no rule (as per the course teaching) that requires multiplicities to be on different sides of association lines. All multiplicities have been clearly labelled in the diagram, positioned close to the classes they are associated with.

Some multiplicities overlapped with the association lines due to PlantUML's formatting issues and there is little that can be done to modify the auto-generated UML diagrams. In any case, the multiplicities can still be clearly seen on the UML diagram and does not affect the readability nor comprehension of the diagram. The bug is thus downgraded to severity very low as it is purely a cosmetic issue.

Duplicate status (if any):

--