search

godjuansan / pe

0 stars 0 forks source link

User Guide Bug : `massblist` #19

Open godjuansan opened 3 years ago

godjuansan commented 3 years ago

The keyword ( blacklist and unblacklist ) must be in lower case.

It is not clear that blacklist and unblacklist are variants of parameters to be put into b/BLACKLIST_OR_UNBLACKLIST since it is never mentioned in the UG.

Screenshot from 2021-04-16 15-30-17.png

nus-pe-bot commented 3 years ago

Team's Response

Remark: The reason for rejecting this issue is very similar to the issue "User Guide Bug : sort"

The purpose of the user guide is not to include every single detail. For example, in the default AB3 add command add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]..., it is already well-understood that n/NAME refers to the name of the contact. (Imagine how long the user guide will be if every single detail is included)

Returning back to our original issue, here b/BLACKLIST_OR_UNBLACKLIST is already stated under the format section. Note that the keywords blacklist and unblacklist are not used anywhere else in the software as an input. Thus there is no ambiguity that the keywords blacklist and unblacklist must refer to the input parameter of the command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree, adding extra explanation that the variable BLACKLIST_OR_UNBLACKLIST should be blacklist or unblacklist should make sense as it is not a huge addition to the user guide and not make it cumbersome.