nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Syntax of calling methods is unclear #1576

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.


There are several instances of referencing to method calls. For instance Chim.deleteCustomer() Chim.deleteOrder() This seems like Chim has a static method. perhaps you could use Chim#deleteOrder() instead?


[original: nus-cs2103-AY2021S2/pe-interim#1576] [original labels: severity.Low type.DocumentationBug]

aaronsms commented 3 years ago

Team's Response

Rejected. First of all, the method is not a static method. Furthermore, there's no one standardized notation when referring to method references. Taking Android Developer Guide as an example, you can find similar method references style.

Duplicate status (if any):

--