benjiBase / pe

0 stars 0 forks source link

Incorrect UML Notation in Developer Guide Diagrams #2

Open benjiBase opened 1 week ago

benjiBase commented 1 week ago

Description: Two UMLdiagrams in the Developer Guide contain incorrect notations. The Logic component diagram and the Parser diagram use a double-headed arrow bracket <> underline in the images, which is not a valid UML notation taught in this course. Instead, an association label should be used to indicate the direction and nature of the association between components.

Steps to Reproduce:

  1. Open the Developer Guide.
  2. Navigate to the Logic component section and locate the first and third diagrams.

    Expected Result: All UML diagrams should follow correct UML notation. In this case, valid association lines with labels should be used to represent relationships instead of using double-headed arrows.

    Actual Result: Double-headed arrows are used to indicate relationships, which is incorrect UML notation.

image.png

image.png

Proposed Solution:- Update the UML diagrams to use proper association labels instead of double-headed arrows to ensure compliance with UML standards.

nus-se-bot commented 1 week ago

Team's Response

As stated below, optional notations are not considered bugs and the double-headed arrows do not contradict standard UML notation.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]