search

TimothyLKM / pe

0 stars 0 forks source link

Colour blocking for the class #8

Open TimothyLKM opened 7 months ago

TimothyLKM commented 7 months ago

you could use the same colour for classes and their respective running bar in the sequence diagrams. Screenshot 2024-04-19 at 5.32.14 PM.png for example :viewcommand can be green.

nus-pe-script commented 7 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Colour or not to colour in UML diagrams

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.

Across the DG, 1 UML diagram has colour for the bar, while the other has a yellow colour for checks. Could you standardize the colours or remove all colours from all UML diagrams

Screenshot 2024-04-19 at 5.36.44 PM.png

^^Should the other blocks/UML diagrams have colour too? If not, what's the point of colour blocking that rectangle.

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

Their Response to the 'Original' Bug

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

Thanks for reporting this observation.

The purpose of colouring the bars is to segregate them as they overlapped between each other. This is to enhance the readability for the readers. We understand your concern regarding the standadization of colours across the UG, but the colours are unique to each command's diagram.

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: This is a suggestion to colour their methods and classes to make the diagram more appealing and readable

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Half coloured diagrams make the DG look unappealing and messy.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]