search

KenCheung18 / pe

0 stars 0 forks source link

Lack of class diagram #16

Open KenCheung18 opened 11 months ago

KenCheung18 commented 11 months ago

Lack of class diagram in DG

nus-pe-bot commented 11 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]

There are no class or object diagrams in DG

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.

No details provided by bug reporter.

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

Their Response to the 'Original' Bug

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

Rejected - Due to the large scope of our classes and various commands, we omitted the diagrams for readability.

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`] - [x] I disagree **Reason for disagreement:** As stated in the PE page that use of visual is one element of the DG, and using sequence diagram is not enough for the developer to understand the entire structure of the code. It is not necessary to have class diagram for all classes but some of the majority class like classes with inheritance should use class diagram to illustrate the relationship between classes
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This bug is definitely not a flaw that is purely cosmetic and does not affect usage, since the developer need to use the DG to understand the overall structure of the code, without knowing some classes relationship will causes occasional inconvenience to the developer when looking at the overall structure of the app.