astralum / pe

0 stars 0 forks source link

Inconsistent accepted input parameters for journalling #16

Open astralum opened 2 years ago

astralum commented 2 years ago

I am required to specify a notebook by its index when tagging a notebook, but must specify the name when deleting one. Some more, the same tag "n/" is used to specify both. In addition, deleting a notebook doesn't even require a tag before specifying the index. This is inconsistent.

soc-pe-bot commented 2 years ago

Team's Response

The bug reported is not valid because I have mentioned all the commands in the User Guide, and it is expected for the user to input the same commands and if the user attempted to input invalid commands then appropriate error messages were already displayed. This appears to be a personal preference of the author of this bug report and is not a bug in the product.

Furthermore, the statement is incorrect "I am required to specify a notebook by its index when tagging a notebook, but must specify the name when deleting one."

Both tagging a notebook and deleting a notebook require notebook index and not notebook name.

image.png

image.png

In regards to the concern "In addition, deleting a notebook doesn't even require a tag before specifying the index."

The reason why deleting a notebook doesn't require a tag before specifying the index but tagging does is because tagging a notebook needs two parameters tag name and notebook index. This is necessary for input validation so that necessary error messages can be displayed to the user, so that they could know which of the parameters are missing or invalid. Deleting a notebook just requires a single parameter: notebook index.

Lastly, in terms of user-friendliness, the commands aren't too long or unnecessarily complicated. They are short enough and thought has gone into them in order to make the journaling easy to use for the user by displaying very specific error messages which results in tags for some and no tags for others in order to facilitate input validation.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]