Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bad wording for Parameter Constraints #10

Open
Dethada opened this issue Apr 19, 2024 · 1 comment
Open

Bad wording for Parameter Constraints #10

Dethada opened this issue Apr 19, 2024 · 1 comment

Comments

@Dethada
Copy link
Owner

Dethada commented Apr 19, 2024

The use of should implies that it is possible to not follow the constraints, which is not the ideal wording.
image.png

@nus-se-bot
Copy link

nus-se-bot commented Apr 22, 2024

Team's Response

Thank you for raising this concern. However, our team thinks that Should be is a reasonable wording. Since we as developers have no control over the user's input, the user is free to enter a value that is not within the constraints, but our program will not accept the value and display an error message. Hence, should is an ideal word to describe what they users should do as they can choose not to do so, except that our program will display an error message. Furthermore, it is intuitive for users to follow the constraints stated. Hence, the wording does not affect the users' usage and we do not think of this as a bug.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: Should is not an ideal word as although users are able to freely type on their keyboard by writing things out of the contraints above, this only produces error messages that renders the app useless for the users. And the very response of throwing error means that they are not allowed to enter other things out of the constraint.

By convention, contraints is definitive words like "must", and not ambiguous instructions like "should" as contraints implies a limit on the way users can interact with the field. Inappropriate wording to "Should" causes confusion as readers might take it as a suggestion but in reality, it is a hard limit on what they can and cannot do.

image.png


❓ Issue severity

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

  • I disagree

Reason for disagreement: Not just cosmetic as it causes confusion as readers might take it as a suggestion but in reality, it is a hard limit on what they can and cannot do.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants