lixupengg / pe

0 stars 0 forks source link

UG parameters are wildly inconsistent. #21

Open lixupengg opened 4 years ago

lixupengg commented 4 years ago

In their UG, it is stated that parameters inputted by the user would be in UPPER_CASE. However, there are many instances where the parameters turn up to be lower case in their UG, while there are other instances where the parameters are correctly identified as UPPER_CASE.

image.png

image.png

image.png

(There are many other instances, but not enough time to capture them all down)

nus-pe-bot commented 4 years ago

Team's Response

severity.Medium -> severity.Low

From the guideline: severity.Low : A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only.

First instance being captured is an example usage of the command. Parameters are being replaced by the example usage after (e.g.).

For [d/description] it is indeed a typo, it should be [d/DESCRIPTION]

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]