Jiacheng-y / pe

0 stars 0 forks source link

Documentation Bug: Diagram does not match code structure #7

Open Jiacheng-y opened 2 years ago

Jiacheng-y commented 2 years ago

The team does not have any FindCommand file in their code base

Screen Shot 2022-11-11 at 17.23.19 PM.png

However, in the logic diagram here, an example of FindCommand being one of the commands in PennyWise.

Screen Shot 2022-11-11 at 17.22.42 PM.png

As a reader I am given the impression that there is a FindCommand Class but I cannot find it in the code base. This hinders my understanding of the code structure as I am left wondering where this FindCommand Class is and whether the diagram is reliable.

soc-pe-bot commented 2 years ago

Team's Response

Reason: It is a typo as there was no mention of the FindCommand anywhere else within the DG, just a cosmetic issue on the diagram itself.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]