marekpinto / pe

0 stars 0 forks source link

Help output should match order of commands in User Guide #13

Open marekpinto opened 1 year ago

marekpinto commented 1 year ago

The order of commands in the help command output is different from the order they are presented in the User Guide. This can likely slow down the user, as they may want to look at the User Guide for more information after looking at the help menu. It would be helpful for them to be presented in the same order.

soc-pe-bot commented 1 year ago

Team's Response

While acknowledging the minor inconvenience that may arise, it is worth noting that the User Guide includes hyperlinks at the top of the page, which can be accessed via the Table of Contents. These hyperlinks are designed to allow users to easily navigate to a specific feature in the help section without having to scroll through the entire page. In fact, this is the primary purpose of including hyperlinks and a table of contents, which largely mitigates any scrolling-related issues. Therefore, it can be concluded that this is a relatively minor concern.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]