nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Error in sequence diagram #1526

Open nus-se-script opened 5 months ago

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


Should not have blocks that are broken down in the middle.

Screenshot 2024-04-19 at 5.41.07 PM.png


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

YHWong20 commented 5 months ago

Team's Response

From the textbook:

image.png

The two separate activation bars are for two separate events when the UI's methods are invoked.

The first bar signifies that the readUserCommand() method is called for the UI to read the user command.

The second bar signifies that the talk() method is called for the UI to print the execution output.

This diagram is therefore valid.

As this appears to be a misunderstanding of the diagram, we will reduce the severity of this bug from Medium to VeryLow.

Duplicate status (if any):

--