nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect class diagram format #841

Open nus-se-script opened 5 months ago

nus-se-script commented 5 months ago

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

perhaps missing "+" for itemManager class methods


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

Zhengwinter commented 5 months ago

Team's Response

By convention, an interface is understood to have public methods. An interface can never have private methods because it can never be implemented!

Adding "+" does not add value and is redundant.

photo1713688691.jpeg

The CS2113 website also did not include the "+"/"-" in front of the methods (seen above).

Duplicate status (if any):

--