search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Error in warning activity diagram. #2126

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.

image.png

There are 2 issues: firstly, the true and false in confirm to proceed with command should have guard clauses. Secondly, the condition, confirm to proceed with command should not be inside the diamond, rather, it should be outside, as [User confirms to proceed with command] and [else].

To sum up, the guard conditions should be replaced accordingly:

true with [User confirms to proceed with command] false with [else]

[original: nus-cs2103-AY2122S1/pe-interim#2085] [original labels: severity.Medium type.DocumentationBug]

yatbun commented 3 years ago

Team's Response

Thank you for your issue! We agree with the notation errors in the activity diagram, however, we decided to downgrade the severity of the issue to low because it does not hinder the reader about his understanding of the overall warning class as the diagram is still intuitively clear on what it is trying to convey.

Duplicate status (if any):

Duplicate of #5613