nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Unintuitive guard clauses used #5724

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.


Some guard clauses are not given as proper conditions, such as add and add-expense or add-income

Screenshot 2020-11-13 at 17.31.54.jpg


[original: nus-cs2103-AY2021S1/pe-interim#5688]

wltan commented 3 years ago

Team's Response

This diagram is a summary of the logic described earlier (on page 15), so the reader should know that the decision is with regards to the command that was entered.

From an example in the textbook, guard conditions need not be very explictly defined as proper conditions if it's clear what it's referring to. Under Activity Diagrams -> Introduction -> What:

image.png

Duplicate status (if any):

--