search

nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Lack of Sequence Diagram #2487

Open nus-pe-bot opened 3 years ago

nus-pe-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.

image.png

image.png

I feel like there is a lack of sequence diagrams here.

It feels like an excessive usage of code as well. Moreover, the code snippet was also used repeatedly.

[original: nus-cs2113-AY2021S1/pe-interim#2413]

JohnNub commented 3 years ago

Team's Response

The interactions between the Ui and the parser as described are shown in the sequence diagram at the top of section 3.1. As the diagram that would be used is repeated, we did not post the same diagram twice. The paragraph highlighted is a more in depth explanation on the processes and datatypes involved from the perspective of the class Ui & Command while the explanation in the Parser section covers the first half of the diagram (conversion to userInput)

Duplicate status (if any):

--