GithubHelp home page GithubHelp logo

Bad wording for Parameter Constraints about pe HOT 1 OPEN

Dethada avatar Dethada commented on August 20, 2024
Bad wording for Parameter Constraints

from pe.

Comments (1)

nus-se-bot avatar nus-se-bot commented on August 20, 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.


from pe.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.