search

nihalzp / pe

0 stars 0 forks source link

Unnecessary methods and data members in diagram #13

Open nihalzp opened 9 months ago

nihalzp commented 9 months ago

image.png

The diagram is overloaded with information - hard to understand what methods/data members are most important

soc-pe-bot commented 9 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]

Too complicated and non-standard notation

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 whole entity box contains too much information (and most of the attributes and methods are unnecessary to display), and it gets a non-standard notation.

The suggestions lies in that you can split the complicatedly-composed entity group into smaller pieces which has clear functionalities, and call the function in each separate entity.

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

Their Response to the 'Original' Bug

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

Hi, thank you for your bug report. However, we are unable to identify the non-standard notation that the tester has mentioned. Additionally, the additional information does not affect much of the 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: My issue is a subset of the original issue.

## :question: Issue response Team chose [`response.IssueUnclear`] - [x] I disagree **Reason for disagreement:** This is not good. The original mentions two issues — lots of unnecessary methods/data member, and non-standard notation. My issue only focused on lots of unnecessary methods/data member. But, the dev team focused on the second point of the original issue "non-standard notation" and deemed the entire bug report "IssueUnclear". But, if only consider my bug report, the issue is not unclear.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]