Elyovs / pe

0 stars 0 forks source link

InteractingCommand Sequence diagram wrong arrow notation #20

Open Elyovs opened 2 months ago

Elyovs commented 2 months ago

Return arrow should be in dashed line instead of straight line.

image.png

nus-pe-bot commented 2 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]

"Interacting with Environment Component" Sequence diagram: Return arrow should be dotted line

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.


Problem

The sequence diagram for Interacting with Environment Component uses a solid line instead of dotted line for return value. This is incorrect notation.

image.png


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

Their Response to the 'Original' Bug

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

This notation error does not hurt the credibility of the diagram.

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 response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** Error in arrow notation between dotted line and straight line will cause confusion to reader and changed the meaning in the diagram. Since giving straight line will looks as if another method is called after setNextDialogue(dialogue), especially if less relevant details can be omitted. Notation error does hurt the credibility of diagram. ![image.png](https://raw.githubusercontent.com/Elyovs/pe/main/files/a202995a-c5b1-43eb-905c-d7afd9d644d8.png)
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]