nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

alt frame did not partition the paths #212

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

image.png The alt frame is not partitioned properly. It is confusing for the reader to determine whether updateExpenseBalance, changeBalancefromexpense etc. are part of the same path or different path. Should it be different, the conditions for the other paths are missing.


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

limkongkiat commented 1 week ago

Team's Response

We acknowledge that there is a slight deviation of the diagram labels from the UML standards, and that using the opt label instead of alt would be more appropriate. However, given that alt and opt represent similar things in terms of the code which it is representing (if blocks), we feel that it is reasonably inferrable to the reader that the frame would be an opt frame (execute only if the entry is an Expense or if category is specified), thus we feel that the inconvenience this brings to the user is quite minor and thus feel that the appropriate severity should be a low.

Duplicate status (if any):

--