search

nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

UG about index can be clearer #2515

Open nus-pe-bot opened 4 years ago

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

image.png

Quite a few commands do not warn the users an index should not be larger than the list size. However, this kind of warning messages do show up in DG test manual.

[original: nus-cs2103-AY1920S2/pe-interim#2503]

sarahcxh commented 4 years ago

Team's Response

The requirements of the INDEX command was explained previously for (ab)edit, which is listed above all these commands. It is assumed you read the UG from top to bottom. Hence the values for INDEX was not repeated for these commands.

Furthermore, what constitutes a valid value for INDEX should be quite intuitive.

Duplicate status (if any):

--