search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Too much information in UML for tab switching #525

Open nus-pe-bot opened 3 years ago

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

Too much information given when they could just show from input parser or logic manager onwards, makes everything too small and complicated image.png

[original: nus-cs2103-AY2021S2/pe-interim#525] [original labels: severity.Low type.DocumentationBug]

ivantjh commented 3 years ago

Team's Response

Thank you for your feedback. The team has reviewed this report and decided that this is not an issue.

Reason

Both UI and Model portions are essential for this diagram.

Elaboration

As per the steps mentioned above the diagram, this portion of the UG provides a walkthrough of how developers can use commands to toggle the tab on the UI.

Screenshot 2021-04-19 at 11.04.07 AM.png

In the sequence diagram, we showcase how a command can be executed to create a CommandResult with the tab parameter. It will then be passed to the UI component MainWindow, which then checks for the tab parameter and updates the DetailsPanel respectively. Hence, we disagree that this sequence diagram is complicated or has too much information.

Duplicate status (if any):

--