BryanCastorius / pe

0 stars 0 forks source link

Confusing -h in Every Command Description #12

Open BryanCastorius opened 4 months ago

BryanCastorius commented 4 months ago

Including "-h" in one of the parameters for each command is confusing when retyping (i.e. modify and modify -h has the same functionality, just makes the user confused whether to input -h or not).

Screenshot 2024-04-19 172919.png

Screenshot 2024-04-19 172931.png

nus-pe-script commented 4 months ago

Team's Response

While modify and modify -h may output the same message, the intention are as such:

Attached below is an example of the intended usage of this feature: image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Thank you for pointing this out and appreciate the detailed response. However, shouldn't this explanation be explained in the User Guide? As I just knew that adding -h to an incomplete command can ignore the error and print out the full command message instead.