YongbinWang / pe

0 stars 0 forks source link

Repetitive nature regarding case-sensitive comments. #12

Open YongbinWang opened 1 year ago

YongbinWang commented 1 year ago

Describe the bug

There is no need to reiterate that the command is case-sensitive for every command when it can be included under command format. Whereas right now some commands are explicitly stated to be case-sensitive while some are not.

To Reproduce

Steps to reproduce the behavior:

  1. Ctrl-f case-sensitive in the UG

Expected

One sentence to summarize which commands are case-sensitive would suffice.

Actual

Some commands are stated to be case sensitive while some are not.

Screenshots

image.png

image.png

nus-pe-script commented 1 year ago

Team's Response

We believe that this is necessary and important to be clear given the amount of "documentation bugs" relating to ambiguous command format.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree, the team's response is contradictory to their user guide, they claim that it is to address ambiguous command format for all of their commands but some commands are explicitly stated to be case-sensitive while some are not, which makes their user guide more ambiguous.

In addition, they did not address my issue on some commands being stated to be case-sensitive while some are not. When I was testing their application, I am unsure which commands are case-sensitive and which ones are not.

Lastly, the repetitive yet inconsistent nature of how they addressed this case-sensitivity issue should be a DocumentationBug under neatness and correctness.

image.png