search

AlyssaPng / pe

0 stars 0 forks source link

If word contains recognised prefix not allowed #4

Open AlyssaPng opened 10 months ago

AlyssaPng commented 10 months ago

Dis not specify the values that can be use in WORD in UG.

image.png

Separate words can be added. image.png

nus-pe-bot commented 10 months ago

Team's Response

image.png

It is written that words can take in all inputs, as long as it is not blank. This is in line with our principles of being fully customisable.

image.png

Furthermore, the command format does not have anything that says you should use two prefixes. While many other groups do indeed use this method of multiple flags to get multiple of the same type of parameter, we have opted to use ... to take in multiple inputs, which are comma-separated. Therefore it is not expected that users will use multiple flags in one command.

The level is changed to low since all our examples and description in UG use all non-repeated prefixes and clearly highlights the "full customizability". A user that follows our UG shouldn't encounter this situation and it's unlikely to affect normal operations of the product.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: When saying an input is fully customisable, i would assume that "hello w/there" is a valid input for parameter WORD as it is not empty as you mentioned is the only restriction of your inputs. Therefore by keying in "hello w/there" as input for WORD as shown in the screenshots above, the expected output will be that it adds a flashcard with the WORD "hello w/there" and the TRANSLATION to "你好". But this triggered an error message for having multiple prefixes of w/ which was not mentioned in the UG the presence of w/ in the WORD input to be detected as a prefix. Therefore, i believe since the behaviour differs from the UG which mention it is "fully customisable", it is functionality bug.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I believe that the add command is a essential command that majority of users have to use. Thus, this may cause occasional problems for users as it is users are led to believe that beside empty values, all other inputs are allowed.