search

jing-xiang / pe

0 stars 0 forks source link

Unclear labeling of "a" for help sequence diagram for developer guide #22

Open jing-xiang opened 4 months ago

jing-xiang commented 4 months ago

Unclear on what a: means Might not be following sequence diagram conventions

image.png

nus-pe-script commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Unclear sequence diagram naming convention for compare flower

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.

Unclear as to what "a" represents in the compare flower sequence diagram

Needs more explanation in the following texts or should be supported in the sequence diagram itself

image.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

a is the object we instantiate of the "CompareCommand" class. Hence the syntax "a:CompareCommand". Understood that this can be confusing, so it is a valid suggestion.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]