search

rushilramesh / pe

0 stars 0 forks source link

Incorrect delete command in DG #11

Open rushilramesh opened 2 years ago

rushilramesh commented 2 years ago

image.png

This incorrect command and diagram can be seen in the introduction of the DG. As there is no such command in the UG, this should be updated to reflect the new version of the delete command.

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Irrelevant diagrams included in DG

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.

GoMedic no longer has the delete INDEX command that was in AB3 but the diagram is not updated or removed.

This might mislead future developers when they encounter this diagram, showing the sequence diagram of a non-existent command in GoMedic.

image.png

[original: nus-cs2103-AY2122S1/pe-interim#4754] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for the response :) Indeed delete XXX command doesn’t exist in the current version of GoMedic. However, the interaction between GoMedic components does not change and the overarching logic remains the same. It is just the method name that changes and hence it should not confuse the future developers too much.

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.VeryLow]

Reason for disagreement: Hey guys not sure why you increased the severity to medium? I think it should be a low severity bug as you mentioned it is a typo that you overlooked.