search

chanyijuan / pe

0 stars 0 forks source link

Inconsistent use of underscores #11

Open chanyijuan opened 2 years ago

chanyijuan commented 2 years ago

Some parameters referenced in the command 'Format' have underscores, while others do not.

e.g. DATE_TIME in addProc has underscore, while CLIENT INDEX does not

Screenshot 2022-04-16 at 3.17.52 PM.png

nus-pe-script commented 2 years ago

Team's Response

It was pointed out previously that a DATETIME could cause confusion to users as it is not an actual word, hence better to separate it.

Moreover, the only field that is not underscored is the index field, such as CLIENT INDEX and PROCEDURE INDEX, this separation of format is intentional to indicate to the users that they are not part of any of the flag assignment (like how information and cost require a flag), and the users pointed out this way could be better to tell they are distinct fields and inputs from other fields with flag indication. This is made even clearer by using different brackets. <>

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]