search

juliusgambe / pe

0 stars 0 forks source link

[DG] Model UML #14

Open juliusgambe opened 9 months ago

juliusgambe commented 9 months ago

Unable to differentiate which arrow does 1 refer to for TimeIntervalList

Screenshot 2023-11-17 at 5.26.40 PM.png

nus-pe-bot commented 9 months ago

Team's Response

We understand the numbering in the diagram is confusing to some. However, this is a limitation of plantuml as images are autogenerated from software. Thus, we were unable to shift the number.

The 'Original' Bug

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

DG - UI Class Diagram can be neater

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.

The following is ProjectPRO's UI Class Diagram in the Developer Guide

image.png

The arrows in the lower right part of the diagram could have been neater by combining the overlapping arrows inside the .puml file for the UI Class Diagram. (Something similar to skinparam group Inheritance)

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

Their Response to the 'Original' Bug

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

We understand that the arrows are arranged in a messy manner in the diagram. However, this is a limitation of plantuml as images are autogenerated from software. Thus, we were unable to make the diagram tidier.

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:** According to the admin information, ![Screenshot 2023-11-21 at 5.35.04 PM.png](https://raw.githubusercontent.com/juliusgambe/pe/main/files/6400abc7-69e8-43e0-857e-bf492247bc95.png) It states that you can use other diagramming tools if there's a strong need. In this case, that the class diagram represents an important component of the system, I believe that the team should have looked into choosing another UML generator for these diagrams to ensure clarity.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]