Kair0s3 / pe

0 stars 0 forks source link

Confusing documentation on the rounding up of the weight #3

Open Kair0s3 opened 2 years ago

Kair0s3 commented 2 years ago

The note that says "if the next digit is 5, it rounds down instead of up" may be confusing for readers as it is rather ambiguous and they would not know which this next digit is referring to, or with respect to which digit. Maybe an example would be better for reader and users to properly follow how they weight works.

image.png

Personally, I feel that the weight rounding can just be sticked to one method e.g. just rounding up/just rounding down rather than having multiple cases to round up/down.

eg. of how it is confusing - only when testing/trying out would we understand which this "next digit" is referring to (as underlined).

image.png

As shown, the 55.65 -> 55.7 (round up) while 55.35 -> 55.3 (round down). Hence, it may be confusing for reader as well as user if they are trying the program based on the UG.

Overall, I consider this a high severity since, some users may want to stay true to their weight rather than having it rounded down just because of the "next digit" as mentioned in UG.

nus-pe-bot commented 2 years ago

Team's Response

Accepted but we feel that the severity should be medium instead of high as:

  1. Most bathroom weighing scales are in one decimal place instead of two, so the user is likely not to know what their weight is to the precision of two decimal places anyway - thus the frequency of this bug affecting the user would be very low
  2. If the user used a weighing scale with 2dp precision, the weight recorded in FitNUS (to 1 dp) would be inaccurate regardless of whether it was rounded up or down, and the user would have known this through reading the user guide and finding out that FitNUS does not support weight of precision greater than 1dp. Thus the user would already be aware of the possibility of slight inaccuracies in weight recording that do not affect the big picture of tracking weight progress in the long term.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: [replace this with your explanation]