search

filbertphang / pe

0 stars 0 forks source link

UG: Inconsistent use of additional parameters #9

Open filbertphang opened 1 year ago

filbertphang commented 1 year ago

In the introduction, it is mentioned that parameters that can be repeated multiple times will have ... after them.

image.png

However, for the find command, some other syntax was used:

image.png

Following the original syntax, the command summary also suggests that only 1-2 keywords can be supplied.

image.png

nus-pe-script commented 1 year ago

Team's Response

Agreed, but it is a minor cosmetic issue and severity should be very low. It does not change how the user uses or reads the guide.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: This is more than a cosmetic issue, as the description used in the UG affects the way users may use the find command.

I assume the the case of \[MORE_KEYWORDS\] is a String escaping issue rather than an intended one, which can be excused.

Nevertheless, the given command is find KEYWORDS [MORE_KEYWORDS] instead of find KEYWORDS [MORE_KEYWORDS]..., so users may think that the find command can only be used to search for up to 2 keywords at a time. This may impact how users use the application.