search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Storage component lacking elaboration #2882

Open nus-se-bot opened 3 years ago

nus-se-bot commented 3 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.

The sequence diagrams contains a lot of information but they were not explained properly. Some of the methods in the sequence diagram is not trivial, and more details could have been provided to explain the logic.

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

yuejunfeng0909 commented 3 years ago

Team's Response

"Some of the methods" is not very specific.

The logic for the storage is pretty simple but involves a lot of trivial interactions between different components. It would look very wordy if it was explained in words, which could be more confusing.

Duplicate status (if any):

--