search

Prearo / pe

0 stars 0 forks source link

Unclear class diagram relating Logic and Model classes #17

Open Prearo opened 1 year ago

Prearo commented 1 year ago

image.png

There are many red underlines which are nonstandard.

Additionally, the term results (below CommandResult) is not descriptive.

These two mean that readers might be a bit confused by this diagram.

soc-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]

DG UML Diagram not well formatted

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.

Screenshot 2022-11-11 172133.png

There are red squiggly lines below class names

[original: nus-cs2103-AY2223S1/pe-interim#2004] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

There is no way to compromise on the naming of TaskCommand, ProgressCommand etc. Otherwise, it would make this class diagram straight up invalid.

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: "There is no way to compromise on the naming of TaskCommand, ProgressCommand etc. Otherwise, it would make this class diagram straight up invalid."

This is easily fixed by recreating the diagram in any suitable software (powerpoint, paint, photoshop, etc.)

In Microsoft Office apps, disable the squiggly lines by ignoring them as spelling errors or adding them to dictionary.

:question: Issue severity

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

Reason for disagreement: This is nonstandard notation in a diagram with specific syntax. Potential developers may be left slightly puzzled while they read your developer guide.