search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Discrepancy in handling void return methods in sequence diagrams #1304

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.

It seems that clear(), save(trackingList) and printReaction(output) all have void return type, but only printReaction(output) has a dotted line back to its caller. While both ways are acceptable, it would be better to standardize how void return methods are handled

Screenshot (259).png

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

RainyCodeWizard commented 3 years ago

Team's Response

Even though the printReaction function returns void, it shows output to the user through the command line interface. However, clear() and save(trackingList) functions does not have any outputs to any components. Thus, only printReaction has a dotted line back to the user.

Duplicate status (if any):

--