search

malcolmang / pe

0 stars 0 forks source link

Multiple components missing class diagrams or any other diagrams #14

Open malcolmang opened 2 years ago

malcolmang commented 2 years ago

Class diagrams are not present for several components, including Parser, API, Storage and Logger.

Some of these components sound like they are quite important, but have no diagrams explaining how they interact with each other.

Example:

image.png

nus-pe-script commented 2 years ago

Team's Response

Greetings malcolmang,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) After consultations with the professor, a conscious design choice was made to remove the redundant classes from the class diagram as clutters up the diagram and does not provide any value to the Parser, API, Storage and Logger section.

2) The interactions between the different components can be seen in the "General Interaction of Components" section.

Regards, xzynos

The 'Original' Bug

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

Class diagrams are missing information on fields and methods

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 few class diagrams present in the Developer Guide do not contain any information on what methods and fields are contained within the class.

In general, the only information on what methods are in a class are when they are called in a sequence diagram. An overview for certain components or important classes may make it easier to understand as a developer rather than guessing at what field or methods are present in a class.

Example:

image.png

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

Their Response to the 'Original' Bug

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

Greetings malcolmang,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) After consultations with the professor, a conscious design choice was made to remove the redundant classes from the class diagram as clutters up the diagram and does not provide any value to the UserInterface Component section.

Regards, xzynos

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 bug report is focused on missing class diagrams within documentation.

The bug report this report is marked duplicate of had issues with no fields/method information for classes in class diagrams that are present.

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While class diagrams being simpler is a valid goal, there are simply very few class diagrams in the DG with any information beyond what classes are present.

I do understand that the DG is quite sequence diagram heavy and provides information on method calls there, but at a glance it is hard to tell what each class can do (what private/public methods do they contain? what fields?) if we just rely on sequence diagrams.