aishh12 / pe

0 stars 0 forks source link

Help feature not redirecting to User Guide's url directly #2

Open aishh12 opened 2 years ago

aishh12 commented 2 years ago

Steps to reproduce bug :

  1. type help

Expected outcome : summary of most common commands and their formats and clickable url that directs user to the user guide

Actual outcome :

image.png

Reason for bug report : new users will start with the help command and it'd be inconvenient to be directed elsewhere for fundamental operations. Moreover, making the URL clickable to direct to the user guide doesn't require much additional effort.

nus-pe-bot commented 2 years ago

Team's Response

Thanks for the issue. We consider this feature flaw as not in scope because we did not plan to implement such a feature in v1.4, and it is not essential for the app to be reasonably useful.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: As stated in the module website under feature flaws :

If the feature is implemented to work in a certain way but it could have been implemented to work
in a better way (from the end-user's point of view) without much additional effort, it should be 
accepted as a type.FeatureFlaw, and cannot be categorized as response.NotInScope

The help feature is likely to be most utilised by new users or frequent users who want to refer to the correct syntax of commands. Hence, the convenience of locating this is recommended. It can certainly be implemented in a better way by providing a direct link to click on as opposed to expecting the user to copy the url from the app and paste it in a browser. This is implementation also can be done without much additional effort :)

It's of low severity since unlikely to affect normal operations of the product and can cause minor inconveniences only.