search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UML diagram for UI component missing composition symbol and wrong multiplicity #1287

Open nus-pe-bot opened 2 months ago

nus-pe-bot 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.

The UML diagram for the UI component in the Developer Guide is missing the composition symbol for the HelpWindow association. HelpWindow would not exist on its own without the MainWindow and is as such in a whole-part relationship with MainWindow.

Also I believe that the multiplicity for the HelpWindow association should be just 1. HelpWindow is always instantiated, but just that its visibility is toggled with the hide and show functions. It is not that it does not exist when not seen.

Screenshots: image.png

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

yapxuanxuan commented 2 months ago

Team's Response

HelpWindow is only instantiated when the user clicks on help and not always instantiated.

Duplicate status (if any):

--