search

Vavinan / pe

0 stars 0 forks source link

Example usage giving wrong impression #5

Open Vavinan opened 2 months ago

Vavinan commented 2 months ago

image.png

When we look the first time it has meditracker> in the front, when using the the user might exactly follow the syntax and type them which is a wrong command. Consider removing the "meditracker" in the example usage

soc-se-bot commented 2 months ago

Team's Response

We agree that this can cause potential confusion to the user in the sense that the meditracker> tag may be intepreted as part of a command. We can probably fix this by choosing not to enclose the meditracker tag inside the code block, or just omit it altogether.

That said, the team would like to argue that this is more of a cosmetic issue (hence suggestion to change to VeryLow) since the original intention for us was to show that to reflect how the CLI would look like after you type in the command before pressing enter.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: image.png

As mentioned above, the issue can be considered as cosmetic if it is typo/spacing/layout/color/font in the docs or the UI that doesn't affect usage, but here the problem is with the command syntax which affects the usage of important features. Considering that it affects the usage of the command, it can be categorized as Low severity.