search

ychong032 / pe

0 stars 0 forks source link

Inconsistent format #10

Open ychong032 opened 3 years ago

ychong032 commented 3 years ago

Using curly braces to specify the valid inputs is inconsistent with the rest of the user guide. A suggestion is to replace the item list with "item type" enclosed by arrows and specify the item types below, similar to what is done for compulsory parameters.

image.png

nus-pe-bot commented 3 years ago

Team's Response

The usage of curly braces here is different from the other usage of <optional arguments> or <compulsory arguments>. In <optional arguments>, the user may use any number of the optional arguments. In <compulsory arguments> like v/ for the spend command, users can input any non-negative value they want. However, the curly braces here denotes that the user selects exactly one of the options. The curly braces represent "enumerations" here. Since this is the only time that such enumeration is used in the UG, this is not a problem of inconsistent format.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]