JerryWang0000 / pe

0 stars 0 forks source link

The CliSyntax summary can be put together with the parameters #12

Open JerryWang0000 opened 5 months ago

JerryWang0000 commented 5 months ago

The clisyntax is acutally corresponding with a parameter, so perhaps it is more reasonable to directly put the clisyntax together with the parameter name, saving the effort to cross check. Also in the currrent version, the syntaxes are not exactly in order with the parameters in the chart.

image.png

nus-pe-script commented 5 months ago

Team's Response

We rejected this report because it does not show any unexpected behaviour. We think that this is a better representation as we segregated the areas of concern between constraints and CLI syntax. Furthermore, in the features section of our UG we have quite a few hyperlinks to the parameter constraints table. Hence, by separating the two, we can minimise confusion of readers and allow them to check for the parameter constraints at a faster rate. Therefore, our design choice is better and we have decided to reject this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]