parth-io / pe

0 stars 0 forks source link

Users should be warned that tags are not allowed to contain whitespace explicitly. #6

Open parth-io opened 1 year ago

parth-io commented 1 year ago

Although the UG does state "Tip: You can create multiple tags at once by just separating the different tag names with spaces.", this by itself does not tell the user what the accepted format for a tag is.

image.png

nus-pe-script commented 1 year ago

Team's Response

Ref below:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I already quoted the UG in the original bug report so replying to the bug report with a picture of the same quote from the UG is hardly a defence. Perhaps my explanation was insufficient.

this by itself does not tell the user what the accepted format for a tag is.

What I meant by this is that there is a specific syntax for what the tag (which is a string) can be and this should be mentioned - for example, a constraint is that tags can only contain alphanumeric characters (which is not mentioned in the UG):

image.png

My contention is that, this format is subtle and should be mentioned in the UG. That tags cannot contain whitespace is troublesome for a naive or inexperienced user, as I can accidentally end up creating multiple tags even though I wanted one whitespace separated tag. For example, if I wanted one tag with spaces, the command tag create tag with spaces will end up creating 3 tags instead of one. The UG should make it clear that whitespace is not permissible by having an additional paragraph documenting what the permissible format for a tag string is.