search

godjuansan / pe

0 stars 0 forks source link

User Guide Bug : `sort` #15

Open godjuansan opened 3 years ago

godjuansan commented 3 years ago

It is not clear from the UG that The keyword ( ascending or descending ) must be in lower case. refers to the ASCENDING_OR_DESCENDING field in the sort ASCENDING_OR_DESCENDING example. Screenshot from 2021-04-16 15-17-38.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 : massblist"

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 ASCENDING_OR_DESCENDING is already stated under the format section. Since the keywords ascending and descending are not used anywhere else in the software as an input, there is no ambiguity here that the keywords ascending and descending 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: Adding an extra words of explanation ASCENDING_OR_DESCENDING variable can be replaced by the keyword ... won't hurt at all. Furthermore, the massblist issue has nothing to do with this bug as it is different feature