search

germainelee02 / pe

0 stars 0 forks source link

Wrong UML sequence diagram #24

Open germainelee02 opened 1 year ago

germainelee02 commented 1 year ago

Looking at your code, ListCommandParser actually calls on ParserUtil before it calls on the predicate class.

Your UML diagram is wrong and does not reflect your actual code.

Screenshot 2023-04-14 at 3.26.20 PM.png

soc-pe-bot commented 1 year ago

Team's Response

This DocumentationBug is reclassified at a Low severity, and is rejected. The UML diagram shown reflects the relevant details necessary to understand the list operation. The ParserUtil mentioned in the report is something that was considered to not be important in understanding how the operation is handled, and the behavior of the Parser classes is also covered in another section of the DG (shown below), and was thus intentionally removed from the UML diagram in the interests of avoiding unnecessary repetition.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree. I believe that ParserUtil is an important class especially when you are passing its return values as parameters.

Readers may think that you directly called ListCommandTagPredicate and ListCommandLanguagePredicate without parsing the inputs. This will definitely confuse some readers when reading through your DG and tracing through your code.

We can let the tutor decide if it is important

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]