search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Sequence Diagram for Parser is too complex (A) #2548

Open nus-se-script opened 4 weeks ago

nus-se-script commented 4 weeks 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.

Description: The sequence diagram for Parser is too complex. The validation portion of it can be left out and described within the description. The complexity makes it hard to understand what the Parser is doing. Refer to the red colour boxes titled (A)

Steps to Reproduce: Open the user manual to the section titled "How it works (Sequence)"

Expected Result: The part on validation can be removed and substituted with a UML note saying what it is doing in general

Actual Result: Too complex

Screenshot:

Screenshot 2024-04-19 at 5.39.57 PM.pngScreenshot 2024-04-19 at 5.39.57 PM.png

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

sxfoo commented 4 weeks ago

Team's Response

Thank you for noting this, I do think that it can be difficult to understand the sequence diagram, but that is subject to opinion. The sequence diagram and the description text is meant to be complementary, and read together for the general flow to be understood.

and I have already abstractly described the validation portion as such: 

4. If there is a match, the corresponding CommandMetadata class for the keyword is called upon,
and there will be a further attempt to match the userInput string with the command regex
expression

regex is defined under Glossary as a sequence of characters that defines a search pattern, used mainly for pattern matching within strings.

Your suggestion to substitute the validation portion with a "UML note saying what it is doing in general" will kind of be repeating the same idea that the description is already mentioning.

Duplicate status (if any):

--