nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Confusion in UG. #2599

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


It first claims that either field is needed. Then it says whether it is needed depends on the specific parameter, which might cause the confusion of the user.

image.png


[original: nus-cs2103-AY1920S2/pe-interim#2598]

terencemah commented 4 years ago

Team's Response

The first statement, that "the application will only accept EITHER a person index OR a group index, never both", was meant to stress the point that the application will not accept both index parameters. It does not logically exclude the possibility of the application accepting neither, because implicit in this statement is the qualifier "IF an index is entered", although we agree it could have been clearer to state this qualifier explicitly.

It is indeed a valid source of confusion for some users, who may possibly misunderstand; but not for many others who would interpret it correctly, which is why we believe the severity of this issue is Low. Moreover, it should not affect their usage of the command, as long as they have cross-referred to the other parts of this section, such as the exhaustive list of possible command formats given further below, included precisely to minimise such confusion. This list is depicted in the screenshot attached. Also, we believe that since this is more a matter of subjective grammatical/syntactic interpretation, our group should not be penalised for not foreseeing various other ways it could be interpreted; such feedback is precisely what we validly need to make the user guide as clear as possible for all users.

Screenshot 2020-04-18 at 5.32.46 AM.png

Duplicate status (if any):

--