yleeyilin / pe

0 stars 0 forks source link

Unclear command in notes for command format in User guide #19

Open yleeyilin opened 5 months ago

yleeyilin commented 5 months ago

Below is a screenshot of your user guide:

image.png

Expected / Possible Improvements: 0 times is unintuitive to the reader. It is clearer to use none at all / optional.

This is so as to ensure that your reader / user will not be confused or have a hard time comprehending what the restrictions are.

nus-se-script commented 5 months ago

Team's Response

We acknowledge the use of 0 times may be less intuitive compared to terms such as optional. However, the term 0 times is still technically correct, referring to the optional inclusion of parameters like illnesses. While the documentation is not incorrect, we recognise that the terms used could be clearer, hence we will assign as NotInScope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I believe that this problem is in fact valid since I was unable to understand what "0 times" means because 0 times made me think of using i/ where everything after that prefix is an empty space, when in fact your group meant that I can omit the entire term altogether.

image.png