search

JackieNeoCEG / pe

0 stars 0 forks source link

Arrow Misalignments in the DG #4

Open JackieNeoCEG opened 2 months ago

JackieNeoCEG commented 2 months ago

image.png

image.png

The arrow should start at the base of the line instead of floating, this is according to UML diagram design standards.

soc-se-bot commented 2 months ago

Team's Response

This is mentioned in another issue.

The 'Original' Bug

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

[DG] Inaccuracies in addCourse() sequence diagram

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.

Description

A number of non-course compliant mistakes are made such as

  1. Missing function control return arrow from : Course instance to : Timetable
  2. Self called function arrows (namely those of "courses.add" and "courses.get") do not point to exact edge of call box

2024-04-19T17:38:45,153531125+08:00.png

  1. Missing function control return arrow from above 2 functions as well

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

Their Response to the 'Original' Bug

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

I think this is mainly cosmetics as return arrows are not compulsory too.

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]