search

nus-tic4002-AY2021S2 / pe-dev-response

0 stars 0 forks source link

DG - Activity Diagram for "New Command" when user executes a command is too vague and unnecessary. #114

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.

The Activity diagram shown in the Developer Guide is entirely too vague. The "else" alternate path does not sufficiently state why the execution flow could potentially flow down that path.

"command commits addressbook" is also rather vague and confusing.

image.png

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

linqing42 commented 3 years ago

Team's Response

This diagram was created by AB3 and is still valid for our code, so we did not remove it and is not a bug.

Duplicate status (if any):

--