search

andrechuakj / pe

0 stars 0 forks source link

Duplicate input parameters #2

Open andrechuakj opened 10 months ago

andrechuakj commented 10 months ago

In section 2.3 Input Parameters of the User Guide, the table has the left column as prefix and second column as parameter. However, since there are duplicate prefixes (such as n/ or s/), and unique parameters, it is perhaps more helpful to put the unique identifier (parameter) as the left column instead so that it is easier for readers to read from left to right.

image.png

Rating this severity as very low as this is purely a cosmetic issue that does not really hinder the reader.

nus-pe-script commented 10 months ago

Team's Response

While doing up our UG for 2.3, we tried both ways of presentation mentioned. Parameter as the first column or prefix as the first column, and upon asking for feedback from different users and asking our cs2101 prof, we all came to a consensus it was more intuitive to have the shorter prefix as the first column

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]