search

nhzaci / pe

0 stars 0 forks source link

Addnote Sample Command lacks whitespace #3

Open nhzaci opened 3 years ago

nhzaci commented 3 years ago

Steps to reproduce:

  1. Type in an incorrect command, e.g. 
    addnote n\
  2. The sample command, addnote c/I love yout/CS2103 Test Tag does not add a tag of CS2103 Test Tag due to lack of whitespace between you and t/CS2103 Test Tag.

Expected:

Add new note with

Actual:

Add new note with:

Screenshots:

Step 1:

Screenshot 2021-04-16 at 2.24.24 PM.png

Step 2: Using the sample command

Screenshot 2021-04-16 at 2.25.59 PM.png

Step 3: Not working as expected Screenshot 2021-04-16 at 2.26.12 PM.png

nus-pe-bot commented 3 years ago

Team's Response

This is a very minor documentation bug where we should have written addnote c/I love you t/CS2103 Test Tag instead of addnote c/I love yout/CS2103 Test Tag in the error message shown above. We have decided to downgrade this bug into very low category as we feel this bug happens due to a typo in our documentation which goes in line with this TP grading severity.VeryLow guide. (severity.VeryLow : A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.)

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: Not an issue with the documentation, this bug exists within the application.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: > severity.VeryLow : A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.

While this is a cosmetic bug with the formatting, since the addnote command is one that would be used by most users, and when they seek to follow the example command which has no space in between the parameters.

This is a flaw that confuses users and causes occasoinal inconvenience, having to read through the documentation to look for why the sample command is not working as they would expect.

A user should not have to look through the user guide to figure out errors in their commands, but rather the error should guide them in the right direction.