Jonathan-Cao / pe

0 stars 0 forks source link

Inconsistent attribute name: taskName vs Task Name #10

Open Jonathan-Cao opened 3 years ago

Jonathan-Cao commented 3 years ago

When mentioning the Task Name attribute in plaintext, 2 different ways were used: taskName and Task Name.

image.png

image.png

In the command format, it is either taskName, TASK_NAME or TASK NAME.

image.png

image.png

It would be better if the naming of this attribute can be more consistent for these 2 scenarios (plaintext and command format).

nus-pe-bot commented 3 years ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The inconsistency of the naming of taskName (in find command section) vs Task Name (in the prefixes section) is purely cosmetic and does not really affect usage, though it would help with consistency and cohesiveness in the UG.

image.png

image.png

The proposed severity of this bug is VeryLow, which is not unreasonable.