macareonie / pe

0 stars 0 forks source link

Overlapping text in diagrams #10

Open macareonie opened 2 months ago

macareonie commented 2 months ago

Just a minor nit but certain diagrams (command architecture diagrams) have overlapping text as shown below Possibly due to formatting issues, or the limitations of plantuml when creating the diagrams

image.png

nus-pe-script commented 2 months ago

Team's Response

We flag this as duplicate as #3704 raises the same issue on the same part of the diagram as well.

The 'Original' Bug

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

12. Rendering of diagram issue in Edit Command Architecture

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.


image.png

the arrows with "creates" labels eat into the boxes that they are pointing to.


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

Their Response to the 'Original' Bug

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

Even though this might be a valid bug. We feel that we should not be penalised for this as it should not confuse the reader as you can still read it exactly. :D Thanks for your 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]


## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** With reference to the image below, while I do agree and accept the fact that readers can still read the label correctly and the understanding of the diagram as a whole remains unaffected, it inherently still falls under the category of a VeryLow severity Documentation bug as a minor cosmetic issue. It is not impossible to read, but can definitely still "hinder" a reader from reading the diagram. ![image.png](https://raw.githubusercontent.com/macareonie/pe/main/files/2c51413f-fe34-4423-a638-4b819ecdec00.png)