search

cheeseong2001 / pe

0 stars 0 forks source link

Missing return arrows in overall sequence diagram #13

Open cheeseong2001 opened 4 months ago

cheeseong2001 commented 4 months ago

image.png In picture above under the overall sequence diagram in DG, there lacks dotted lines that indicate a returning of control/flow back to the component that called it.

Few examples below:

image.png

image.png

image.png

and many more.

The return dotted lines are important because it shows that the control is returned back, and not just cut off immediately after the functions are executed.

soc-pe-bot commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Sequence diagram is missing key elements

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.

Absence of self-invoke activation bars:

image.png

image.png

image.png

Return arrows are missing:

image.png

image.png

image.png

Footer box should not be present:

image.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

indeed , there should be a return arrow

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]