brendanneojw / pe

0 stars 0 forks source link

Unclear instruction in the Notes section for Features in UG #8

Open brendanneojw opened 1 year ago

brendanneojw commented 1 year ago

Under the Features section in the information box for Notes about the command format in the UG, point number 3 states the follow Items with | indicate that the command accepts either parameters. e.g mark n/STUDENT_NAME | id/STUDENT_ID takes in STUDENT_NAME or STUDENT_ID as its first argument.

This is unclear as to whether the user will be allowed to key in both and the command still takes in the first argument.

image.png

nus-se-script commented 1 year ago

Team's Response

The team sees no ambiguity in the understanding of the above statement.

It is mentioned clearly what the command accepts through the example: it takes STUDENT_NAMEor STUDENT_ID as the first argument. The logical interpretation for this would be that only one of STUDENT_NAME or STUDENT_ID should be chosen, as it does not make sense for STUDENT_NAME or STUDENT_ID to both be the first argument.

As such, it is quite clear that the user should not be keying in both STUDENT_NAME and STUDENT_ID, when | is used.

Hence, there is no presence of ambiguity to the aforementioned.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]