search

kiatkat / pe

0 stars 0 forks source link

`config` command usage in Quick Start and/or startup is slightly misleading #2

Open kiatkat opened 10 months ago

kiatkat commented 10 months ago

As mentioned in the quick start guide and in the startup text:

image.png

The user is advised to use the config command to configure their module information. However, upon doing so, an error is displayed:

image.png

It is unlikely that a user would have read the command format of the config command before reaching this point, and so would likely try the config command as so. Only then would they have to refer back to the User Guide to understand the proper usage of the command, which is a likely inconvenience.

soc-pe-bot commented 10 months ago

Team's Response

This behaviour is intended as there are too many details and warnings regarding the config command that cannot be displayed in the initial welcome message and UG. For example, the number of tutorials and assignments depends on the user and they should read through the command format message in order to understand this. We also want the user to understand the potential consequences of using config.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]