HemanshuGandhi / pe

0 stars 0 forks source link

UG documentation error: extra asterisk characters #4

Open HemanshuGandhi opened 4 years ago

HemanshuGandhi commented 4 years ago

As seen below, there are the ** symbols in front of the add_person and delete_person commands. This looks like an error (perhaps while trying to apply bold styling).

This could be quite misleading as the user thinks these points are somehow important but they are not so.

Screen Shot 2020-04-17 at 3.09.48 PM.png

nus-pe-bot commented 4 years ago

Team's Response

No response provided.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I would like to argue that this is a documentation bug of medium severity, because this is quite likely to cause "occasional inconvenience to some users". The ** symbols are quite intuitively interpreted as trying mark a certain point as being of significant importance, hence it is misleading to many users. Even for myself, when I first read this portion, I genuinely thought that those two steps were supposed to be very important, and i even tried scrolling around to find some kind of footnote that would explain why those points were bulleted.

Furthermore, this mistake is not just present in one line, but as the screenshot shows, this mistake is repeated in two lines and therefore hard to ignore. Therefore, I disagree that this is "very low" severity.