nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Cluttered sequence diagram #3797

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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).

Screenshot 2021-11-12 at 5.28.35 PM.png


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

jianoway commented 2 years ago

Team's Response

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.

Duplicate status (if any):

--