Hazel1603 / pe

0 stars 0 forks source link

Activity Diagram for delete is too long #31

Open Hazel1603 opened 3 years ago

Hazel1603 commented 3 years ago

it spans 1 and a half pages... which makes it hard to read. There is no need to account for every case because it does not value added to the understanding of the code, rather it seems to diminsh the value

nus-se-bot commented 3 years ago

Team's Response

I feel that each part of the diagram is necessary and essential to show how the command was implemented, so it is not possible to shorten the diagram. I tried putting the diagram horizontally, but it became too wide for the documentation. I also feel that this makes the implementation much clearer to developers as it provides a visual aid to understanding the workflow of the command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think given the length of the activity diagram, it does pose a bug as it becomes hard to follow the full flow of the diagram. Instead, you could have considered using rakes to give a broad overview of the activity diagram first, then give more detailed workflow of the activity diagram.


:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: [replace this with your explanation]