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

Constraints on parameter/attribute values are not explicitly stated in DG/UG #8

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

Comments

@iynixil
Copy link
Owner

iynixil commented Apr 19, 2024

Description:
In both the DG and UG, the explicit constraints for values that attributes (e.g product name, product quantity, dates) can take are not explicitly stated.

Rationale:
While the constraints may be displayed in the error messages of commands, this requires users to use an invalid command for the explanation to appear.
Some constraints are specified in UG but not all.
Unlikely to affect operations as user can still get information from error messages in the app, hence Low.

Recommendation:
Perhaps it is better to include such information in every command section of the UG, or have a table that describes the constraints for each attribute, such that the user is able to refer to the UG to understand what values are accepted for the attributes used in commands and do not have to refer to error messages in the app.

@soc-pe-bot
Copy link

soc-pe-bot commented Apr 22, 2024

Team's Response

According to the course website: "Nitty-gritty details missing from the UG is not a bug long as the user is informed of those details using other means such as error messages or in-app help." Hence, since the constraints are informed with error messages already, we do not accept this as a bug.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: [replace this with your explanation]


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