soc-pe-bot
commented
1 year ago Team's Response
Hi,
Thank you for pointing this out!
We accept this as a bug. The error message's standard format does not contain the "i/" prefix, but we had a typo in the sample command. The user can still double check the user guide, which has more examples that are correct. Plus the standard format in the error message, we believe users can understand the right format.
Technically, a typo only counts as a bug of very low severity, but we understand that a typo in a sample command will carry more significance, so we consider it as a bug of low severity.
Since it is a typo that does not affect any functionalities, we consider it as a documentation bug. The user can still use all functionalities without obstacles.
Have a nice day!
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Mismatch between UG command example and error message example
UG states:
Command error example states:
Do we need the 'i/' key? This causes confusion to user
[original: nus-cs2103-AY2223S1/pe-interim#1721] [original labels: type.DocumentationBug severity.Low]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Hi,
Thank you for pointing this out!
We accept this as a bug. The error message's standard format does not contain the "i/" prefix, but we had a typo in the sample command. The user can still double check the user guide, which has more examples that are correct. Plus the standard format in the error message, we believe users can understand the right format.
Technically, a typo only counts as a bug of very low severity, but we understand that a typo in a sample command will carry more significance, so we consider it as a bug of low severity.
Since it is a typo that does not affect any functionalities, we consider it as a documentation bug. The user can still use all functionalities without obstacles.
Have a nice day!
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FunctionalityBug]
- [x] I disagree
Reason for disagreement: The documentation is correct in this case. This is more of a functionality bug since this was what was recommended by the error message while using the application. Hence, this would be more fitting of a functionality bug since the feature behavior (throwing of correct error message) needs to be updated.
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
My index is 1 which is valid and a whole number. But the error message tells me otherwise.
I used this example from this error message. But I cannot seem to get this command to work:
Another error (index error) is thrown when I used the example from the error message.