search

zixin448 / pe

0 stars 0 forks source link

Incorrect sequence diagram for edit/delete command #15

Open zixin448 opened 2 years ago

zixin448 commented 2 years ago

execute method takes in 3 additional boolean, this does not match what is reflected in the sequence diagram

Screenshot 2022-04-16 at 3.22.27 PM.png

Screenshot 2022-04-16 at 3.22.34 PM.png

Screenshot 2022-04-16 at 3.24.14 PM.png

list execute method takes in 3 additional boolean, sequence diagram only reflected 2, incorrect sequence diagram

Screenshot 2022-04-16 at 3.25.12 PM.png

nus-se-script commented 2 years ago

Team's Response

This is a typo in the Developer Guide. It is not a flaw that causes occasional inconvenience to some users, rather this typo in the diagram does not affect usage of the app. Hence downgrading severity from medium to very low.

The 'Original' Bug

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

Inconsistency between the textual explanation of implementation and UML diagram

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.

Screenshot 2022-04-16 at 3.37.10 PM.png

Screenshot 2022-04-16 at 3.37.24 PM.png

[original: nus-cs2103-AY2122S2/pe-interim#3464] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

This is a typo in the diagram in the Developer Guide that does not affect the usage of the app. Hence downgrading severity to very low.

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.VeryLow] Originally [severity.Medium]

Reason for disagreement: Yes the bug does not affect the users but the purpose of a Developer Guide is for developers who will be enhancing/maintaining the app and the diagrams are needed for the developers to understand the structure/system of the app! I feel that such errors in the diagram might lead to unnecessary inconvenience when developers try to use the DG. I feel that the severity level should be Low and definitely not Very Low.