nus-pe-bot
commented
2 years ago Team's Response
This was a documentation oversight on our part. In this case, our error message is correct. We indeed have intended for tags to be solely alphanumeric without spaces and made an error in our UG.
Items for the Tester to Verify
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FunctionalityBug]
- [x] I disagree
Reason for disagreement: As clearly stated in the User Guide, the tag "can only take in alphanumeric characters and spaces". A user who reads this and inputs a tag with a space is unable to use the command at all. In fact, one of the examples under the "Adding a tutee: add" header uses a tag with a space (add n/Betsy Crowe l/p5 a/246 Hougang Ave 6 sch/Rosyth p/84567890 t/Northeast region). If a user keys this into the application, he meets an unexpected error as the function does not work as expected.
It is unreasonable to state that this is a documentation oversight when it is a functionality bug. A functionality which the team has stated in the User Guide clearly does not work as expected. Hence, this falls under the "A functionality does not work as specified/expected." description of the FunctionalityBug as stated in the module website.
If this is classified as a DocumentationBug, then we can use a similar logic to group all FunctionalityBugs as DocumentationBugs by simply stating that the team did not meant to state a particular specification in the guides, which would make no sense.
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [x] I disagree
Reason for disagreement: As the User Guide clearly states that a tag "can only take in alphanumeric characters and spaces" but the tag functionality does not work as advertised, this is likely to cause a lot of inconvenience and confusion to a lot of users. Moreover, in one of the examples listed, under the "Adding a tutee: add" header, the team has provided the example add n/Betsy Crowe l/p5 a/246 Hougang Ave 6 sch/Rosyth p/84567890 t/Northeast region. If the user were to paste this in to the application and run it, they will face a error. This is very inconvenient to a lot of users and is likely to be a very common occurrence.
Noting the fact that the tag functionality does not work as promised by the User Guide and that certain command examples themselves are erroneous, I feel that this is a flaw that causes occasional inconvenience to some users and occurs fairly frequently. Therefore, this is better suited as a Medium severity bug.
Although UG states that tags must be alphanumeric, such a tag is not accepted by the app.