search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Missing documentation for meaning of ellipses #3812

Open nus-pe-bot opened 2 years ago

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

image.png

There is no documentation for what the dots in the command format means. Hence the reader might not know what "..." means and have to assume and guess the multiple of such parameters are allowed. This is unrealistic for users who have not used AB3-like applications before.

[original: nus-cs2103-AY2122S1/pe-interim#3759] [original labels: severity.VeryLow type.DocumentationBug]

justintanyf commented 2 years ago

Team's Response

Good eye!

Duplicate status (if any):

--