nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Self invocation within the same class has no return arrow in the sequence diagram. #1241

Open nus-se-script opened 6 months ago

nus-se-script commented 6 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.


image.png

In the following sequence diagram for the storage component, the first self invocation for the storage class does not have a return arrow.


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

iscyng commented 6 months ago

Team's Response

"To reduce clutter, optional elements (e.g, activation bars, return arrows) may be omitted if the omission does not result in ambiguities or loss of relevant information. Informal operation descriptions such as those given in the example below can be used, if more precise details are not required for the task at hand.". Thank you Screenshot 2024-04-22 at 21.19.47.jpg

Duplicate status (if any):

--