tanjiaxian99 / pe

0 stars 0 forks source link

Inconsistent prefixes for INDEX and TASK_INDEX #13

Open tanjiaxian99 opened 2 years ago

tanjiaxian99 commented 2 years ago

INDEX does not require a prefix, while TASK_INDEX requires a -ti prefix. This could be quite confusing for new users who are just starting to use the app.

nus-pe-bot commented 2 years ago

Team's Response

image.png

First off, we did mention clearly in all our command instructions what INDEX refers to, and what TASK_INDEX refers to. So before the user would already be clear of what the command inputs mean.

Since INDEX and TASK_INDEX are used together in the same command, having a -ti prefix makes it more user friendly as it is easier to see which number is for the index of person and which number is for the index of tasks.

Lets take the rm command for example to demonstrate what you deemed as 'consistent':

The flags also implicitly serve a purpose to let users know that it is an attribute associated with the person. For instance, -ti refers to the task of a person, -p refers to the phone number of a person, -a refers to the address of a person etc. Commands except deleting a person and adding a person actually manipulate the attributes related to the person and not the person itself. Going back to your point, giving TASK_INDEX a -ti flag would actually make it clear to the users that they are manipulating the task of the specified person and not the person itself.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]