search

cx0810 / pe

0 stars 0 forks source link

Activity Diagram for `copy` command is too complicated #18

Open cx0810 opened 3 years ago

cx0810 commented 3 years ago

The activity diagram for copy in the Developer Guide takes up 2 pages. It is very hard for readers to view the diagram.

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: The activity diagram is very repetitive (e.g. creating predicate and CopyCommand) and complicated. While it shows the exact workflow of the command, there is no need to elaborate on each action in detail in the activity diagram.