search

bakano98 / pe

0 stars 0 forks source link

Wrong labeling in UG which confuses the reader #12

Open bakano98 opened 2 years ago

bakano98 commented 2 years ago

image.png

The user guide mentions the above symbol/syntax for formatting.

image.png But all find commands have the following symbol/syntax, which is very confusing because it doesn't seem like as if any unwanted behaviour is occurring that would be detriment to my experience, but rather, is this not additional information that may be useful for the reader to know?

nus-se-script commented 2 years ago

Team's Response

We agree with your view that a different symbol should be used. However, we do not think that this issue warrants a low severity as it does not detriment your experience as you have mentioned.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I think I was misunderstood. The "detriment to my experience" part was a rephrasing of what the yellow boxes mean.

image.png
Following the above, I think this deserves a Low because this is not just a cosmetic issue.

To elaborate, as a reader, I am confused as to why I must follow the instructions. I do not see how it "unwanted consequences might arise" if I do not follow the syntax mentioned in the boxes. This confusion causes minor inconvenience to me as the reader (and user), as I would have to decipher why I need to follow the instructions, which IMO, warrants a Low severity.