search

Devanshshah1309 / pe

0 stars 0 forks source link

Unintuitive names of parameters flags - `i` for task description #5

Open Devanshshah1309 opened 1 year ago

Devanshshah1309 commented 1 year ago

Steps to Reproduce

task add tn/Review PR 2 i/Due ASAP d/12/12/2022

It is not clear why i is used to refer to the task description instead of something more clear like td - since you're using tn for task name anyway. This makes it harder for users to remember the parameters and hence, causes difficulty in running the commands. Priority low since it is always possible for users to refer to the UG (but it makes it a very slow process of onboarding)

Expected

A more intuitive command format such as: task add tn/Review PR 2 td/Due ASAP d/12/12/2022

Actual

Unintuitive task add tn/Review PR 2 i/Due ASAP d/12/12/2022 format.

nus-se-bot commented 1 year ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The dev team did not provide any justification for marking this as not in scope.

I think it is entirely fair for this issue to be considered within the scope of this version of the product since it is meant to help TAs get things done fast using CLI. Using unintuitive flags is a bug as it slows down users.

Just curious, what does i in fact stand for in the task add command? (it's not even mentioned in the UG what i stands for)