search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

[DG] Uninformative Sequence diagram #185

Open nus-pe-bot opened 4 months ago

nus-pe-bot commented 4 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.

In the Add expenditure sequence diagram, the return values here are of type boolean, but this part of the sequence diagram does not make sense to me:

image.png

What does boolean mean? It is not immediately clear.

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

Heart-of-N1 commented 4 months ago

Team's Response

Boolean, as per CS1010 teaching materials, refer to true/ false. the naming of the methods also indicate that it is a boolean return type

We would not consider this as an unclear return statement.

Duplicate status (if any):

--