meerkatboy / pe

0 stars 0 forks source link

User Guide Parameter Specification Table is incorrectly labelled #2

Open meerkatboy opened 3 days ago

meerkatboy commented 3 days ago

image.png

In the user guide, the summary table of the specifications for each parameter is labelled as "Command". This can be relabelled as "parameter" to improve clarity. As a first time user, this may be confusing when I try to input "NAME" as a command.

Labelled as medium, as it is not purely cosmetic. As a new user, I will likely head straight to the command summary table to look at the features and what I can do. This table may misguide new users into thinking that NAME is a valid command.

soc-pe-bot commented 10 hours ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

This was a typo mistake on our part but we feel that this does not affect the readability or understandability of the UG as all the parameters are grouped together in the table. The header also states that it is a parameter specification table. Therefore, it would not affect users reading the UG and is a cosmetic issue only.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]