soc-se-bot
commented
2 years ago Team's Response
Reduced from Low to Very Low severity, as it is an UI issue and it is debateable whether it will affect normal operation or cause inconvenience.
The instructions in the bracket and the User Guide would have clearly outlined that the index was referring to the Procedure and Client index, hence this is rejected.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: In other error messages, for example editProc, CLIENT_INDEX is clearly stated. I find it interesting to clearly specify 'CLIENT_INDEX' for a command that only receives 1 index as a parameter instead of a command which receives 2 index as parameters.
While the User Guide elaborates further on the parameters required, the User Guide's purpose is to brief the user on the overall use of the application and understand what sort of commands are supported, while I believe error messages serve as a last chance to catch minor errors a user has made after they have read the User Guide. Therefore error messages should provide clear and concise instructions to prevent users from having to keep referring back to the User Guide. I do not think it is a feature that requires a lot of effort to implement, yet it will clear up ambiguity on the users' end.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Both of the parameters needed in
deleteProcare the referred to as the sameINDEXin the deleteProc error message.Could be clearer if the index was specified.
For example: Parameters: CLIENT INDEX (must be a positive integer and an existing Client) PROCEDURE INDEX (must be a positive integer and an existing Procedure)