nichyjt / pe

0 stars 0 forks source link

DG - Matrix Sequence diagram has wrong syntax #18

Open nichyjt opened 1 year ago

nichyjt commented 1 year ago

Description

The return arrow from function calls should be dotted. This is inconsistent.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Issue accepted. Thanks for your bug finding!

The 'Original' Bug

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

DG - Sequence diagram inconsistent self-invocation syntax

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.


Description

In the DG, self-invocation initally had its own activation bar in the lifeline.

See the quadratic equations sequence diagram, under :QuadraticParser

image.png

But this style is not maintained in the DG. For example, see the Sequence Diagram for File Loading

image.png

This inconsistent styling may make it slightly inconvenient for developers who need to context switch between diagram styling.


[original: nus-cs2113-AY2223S2/pe-interim#1150] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Accepted for inconsistent sequence diagrams

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: The tagged duplicate issue is regarding activation bars for self-invocation.

This issue is regarding the sequence diagram having the wrong type of return line:

image.png