nus-pe-bot
commented
3 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]
Cluttered sequence 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.
RevertCommand sequence diagram is too cluttered and can be split into parts for greater clarity (RevertCommand object and VersionedModel, then RevertCommand object with Storage, then the alt or something like that).
[original: nus-cs2103-AY2122S1/pe-interim#3743] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We felt that the trade off of splitting up into various parts would hinder the user's process in understanding the execution of Revert due to them needing to use multiple frames of reference. Thus, we would like to reject this as a bug.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: As stated in the module website, details in the diagram too small is usually a symptom of having too much info in the diagram. Although the reader can zoom in to see the diagram. Perhaps, some lower level or irrelevant (to the problem at hand) information can be omitted.
Perhaps some of the diagrams included are a little too small, which makes it hard for the reader to read and analyze them.