nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect way of indicating more keywords #3101

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

As below, [MORE_KEYWORDS] would suggest that it is a different parameter form KEYWORD, and that it can only be specified once.

It would be more appropriate to use [KEYWORD]...

image.png


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

jloh02 commented 6 days ago

Team's Response

Thanks for this issue. This has been explained the user guide. This syntax is valid to denote that at least one KEYWORD is required. The KEYWORD [KEYWORD]... may confuse the user further as compared to KEYWORD [MORE_KEYWORDS].... Accepted as we missed out the ... in the photo you shown.

image.png

Duplicate status (if any):

--