search

TriciaBK / pe

0 stars 0 forks source link

Class diagram in incorrect format #16

Open TriciaBK opened 11 months ago

TriciaBK commented 11 months ago

The class diagram in the developer guide does not adhere to the requirements of a class diagram. Instead of just having 1 box for a class, there should be 3 boxes per class, 1 for class name, 1 for attributes, and 1 for methods.

image.png

soc-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]

DG: Class diagram incorrect format

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.

Screenshot 2023-11-17 at 5.21.20 PM.png

  • Formatting is not consistent with CS2113's formatting guidelines

Screenshot 2023-11-17 at 5.22.34 PM.png

  • Very confusing way of expressing the interaction of the various classes as not all classes as shown; a better way will be to use a sequence diagram which is not shown at all throughout the DG

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

Their Response to the 'Original' Bug

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

Thank you for pointing this out. We have decided that this issue is of severity.Low as it definitely can be confusing to any developers reading it as it does not follow standard convention. We should have been more careful with our class diagram and better conformed to industry standards so as to prevent any confusion in the future. Thank you again for spotting this mistake.

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]