search

derekjxtan / pe

0 stars 0 forks source link

Inconsistency in optional paramaters command #18

Open derekjxtan opened 9 months ago

derekjxtan commented 9 months ago

Optional parameters are displayed inconsistently. e.g. delete vs find, one is shown as INDEX ... the other is show as KEYWORD [MORE_KEYWORDS]

nus-se-bot commented 9 months ago

Team's Response

Delete command accepts booking index for parameter but find command accepts room number (not booking index) and/or name.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: In both cases, the first parameter input is compulsory while the others are not. Throughout the whole user guide, optional values are shown in square brackets. Only in the delete command optional parameters are shown as ellipse .... To main consistency in the user guide, the format should have been shown as delete INDEX [MORE_INDICES] instead of delete INDEX ... to show that additional indices are optional. This is purely a cosmetic issue as it does not affect user's understanding of the format.