search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Insufficient output examples throughout the UG #2559

Open nus-pe-bot opened 1 month ago

nus-pe-bot commented 1 month 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.

As a user, I would like to see example outputs of all the possible commands for a better understanding of usage.

However, some commands did not show example output ie add , promotion commands.

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

LowTL commented 4 weeks ago

Team's Response

I do agree that we could have furnished the UG with expected outputs, but as per the AB3 reference, expected outputs are not compulsory in the UG.

Duplicate status (if any):

--