search

jiachen247 / pe

0 stars 0 forks source link

UG sections should be broken down futhur #9

Open jiachen247 opened 4 years ago

jiachen247 commented 4 years ago

For example the add commands like 5 other subcommands in the same section without explaining in more detail what valid parameters are.

Would suggest splitting this up into 5 subsections.

nus-pe-bot commented 4 years ago

Team's Response

We agree that we should provide more information regarding valid parameters. However, we do not feel that the UG should be broken down to many subsections as the purpose and usage of the sub-commands are very similar, and adding extra examples might increase clutter in the UG.

Moreover, despite not being elaborated in the UG, the information usage of the sub-commands have been added into the application and should users violate any constraints of the parameters, the explanation for that particular parameter would be displayed for the user in the application.

We will accept the suggestion regarding valid parameters, and we will downgrade the severity to low as not informing users of valid parameters in the UG may hinder the user experience.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]