search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Naming conventions #96

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

image.png

Are the commands not facilitated by the command class?

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

damiwee commented 5 months ago

Team's Response

For this course, there is no fixed/ standardized format to describe (in words) how our commands are facilitated by the command class. What you see on the AB3 guide is just one possible format that they have used (non compulsory).

While the interface extension was not explicitly mentioned (in words) in the section that you have screenshotted, our class diagrams demonstrates and showcases the use of interface. What you have screenshotted is just briefly highlighting the different commands again. Re-explaining in words for this matter is redundant since the class diagram is simple and straightforward enough. Additionally, _the purpose of the section you have referred to is to highlight the inner workings of the reflection component, not the commands themselves._ We have attached a screenshot of the class diagram for your reference.

image.png

Hence, we would like to reject this report.

Duplicate status (if any):

--