search

niekis / pe

0 stars 0 forks source link

Inconsistent naming in UG #19

Open niekis opened 1 year ago

niekis commented 1 year ago

using NAME image.png

image.png

using ATHLETE_NAME

image.png

nus-se-bot commented 1 year ago

Team's Response

Thank you for bringing this to our attention.

However, I disagree with this issue.

In the add command, NAME was used due to the existing context that it would only refer to the athlete being added.

In the mark command, ATHLETE_NAME was used because there would be ambiguity if only NAME was used.

Just NAME alone could refer to either the athlete's name, or the session's name.

Therefore, ATHLETE_NAME is used so the user makes sure to input the athlete's name and not the session's name.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for the response!

Functionality aside, this still does feel like an inconsistency in the UG, thus the severity: VeryLow.

But even considering functionality, I feel that the add command could have been made even clearer if NAME was replaced with ATHLETE_NAME and that there is no drawback to doing so. There is a small chance that the inconsistency here might cause some confusion in the user.