search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

UML Diagram for Model in DG #853

Open nus-pe-bot opened 16 hours ago

nus-pe-bot commented 16 hours ago

Bug Details

UML Diagram, as seen in the screenshot, is very cluttered. Overlapping words makes it hard to reason with it as well. Might be better to omit such details from the UML diagram instead!

Screenshots

image.png

image.png

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

VedJoshi commented 3 hours ago

Team's Response

This issue arises due to a known limitation of PlantUML when handling complex diagrams with multiple relationships. The cluttered appearance, especially the overlap of elements like ownWedding and weddingJobs, is an unfortunate side effect of this limitation. However, both ownWedding and weddingJobs are integral components of the Person class and serve critical roles in representing the relationships between Person and Wedding in the system. Omitting these details would reduce the completeness and accuracy of the diagram.

While we acknowledge the readability concerns, removing these elements is not feasible. Future iterations can explore alternative diagramming tools or layouts to address this limitation. The diagram is still functional and interpretable despite the visual constraints.

Duplicate status (if any):

--