search

ng-andre / pe

0 stars 0 forks source link

UML Diagram is too complicated #9

Open ng-andre opened 2 years ago

ng-andre commented 2 years ago

image.png

Diagram for edit command is too complicated, can consider abstracting some commands. Same for add and deadline command to a certain degree. The text is too small and there are too many method calls in the diagram, hurting readability. Instead, some method calls can be abstracted out for easier readability.

nus-se-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]

Edit Command very complicated

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.

image.png

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

Their Response to the 'Original' Bug

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

Not sure which part of this sequence diagram is considered "complicated", as I already used a very specific input example to draw this diagram so as to cut down on the complexity (only the EditBookCommand for a specific book is called, rather than for all items and the entire if-else block shown).

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: As mentioned in the issue response, while this is a similar problem to the 'original' bug #1894, I have clearly indicated the issue in my response, unlike the 'original' bug. Therefore, this should not be IssueUnclear.

Thus, I am disagreeing with the duplicate status to give the developers a chance to reject bug #1894 as unclear while giving a valid response for my bug.

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: While this is a similar problem to the 'original' bug #1894, I have clearly indicated the issue in my response, unlike the user who submitted that bug. Therefore, this should not be IssueUnclear. The issue is too many method calls, leading to poor readability.

For sequence diagrams, there is the option of using ref frames to abstract out the method calls for instance. Also, while everything is executed sequentially for one given command, the sequence diagram can easily be split up into parser and execute phase without hurting the reader's ability to follow. In fact, it would lead to improved readability with less clutter.