search

joshuan98 / pe

0 stars 0 forks source link

Class name headers #39

Open joshuan98 opened 1 year ago

joshuan98 commented 1 year ago

Headers on top of class names is non-standard

image.png

nus-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Sequence diagrams do not follow convention

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.

sequence diagrams have additional notation at the top which are not necessary

Actual: image.png

Expected:

image.png

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

Their Response to the 'Original' Bug

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

Format is standardised across the DG. The boxes are part of standard uml notation to provide clarity and structure.

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]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The fact that the format is standardised across the DG does not make it a standard notation for a UML diagram. Perhaps I have a different understanding but I do not remember that the additional headers are "part of standard uml notation to provide clarity and structure".