search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency in the diagrams. #2896

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 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.

image.png

Few dashed arrows show information of what is being returned and few don't.

Example:

image.png

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

theodorekwok commented 2 years ago

Team's Response

From the CS2113T website, the text on the return arrows are for "possibly some return value". The omission of text for some of the return arrows is correct as those methods are void methods and do not return anything.

More details here: https://github.com/nus-cs2113-AY2122S1/forum/issues/140

Severity downgraded to VeryLow as displaying the dashed return arrows is optional according to convention if the returned information are trivial, so having an unlabelled dashed return arrow for void returns is purely a cosmetic preferance and does not hinder understandability of UML diagrams.

Duplicate status (if any):

--