search

hafizuddin-a / pe

0 stars 0 forks source link

Missing explanation for parameters #7

Open hafizuddin-a opened 7 months ago

hafizuddin-a commented 7 months ago

image.png

As a new user, I was unsure of the difference between MAXIMUM_DIGITS and LENGTH_OF_EQUATION when reading the docs. It is rather vague so initially I thought that MAXIMUM_DIGITS was how many numbers in the equation but found that it was how many digits each number in the equation can have. It is explained better in the help menu of the app as shown below.

image.png

nus-pe-script commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Unclear instructions for gen feature

As per help gen command, this is the following output

image.png

Without the user guide, there is a mismatch of [type] and [operators] fields under the help section

Perhaps you could double check the field names for the specified format?

[original: nus-cs2113-AY2324S2/pe-interim#2171] [original labels: type.FunctionalityBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

You are right. That is a typo.

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)

Reason for disagreement: The flaw I highlighted is about unclear instructions provided by the UG. It is not clear what MAXIMUM_DIGITS and LENGTH_OF_EQUATION means in the documentation. The duplicate bug is about having a typo in the help menu.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** It is not very low severity as it is not a cosmetic issue. It is an issue of unclear instructions in the documentation.