search

jamz903 / pe

0 stars 0 forks source link

Documentation for commands that do not have arguments is unclear #8

Open jamz903 opened 10 months ago

jamz903 commented 10 months ago

It should be documented well in the UG that the arguments of commands designed to not have arguments will be completely ignored, with no warning/error given to the user.

Example: when using list, filter m/

When executing filter m/John, it proved to be confusing as it was not obvious at a glance that this parameter was designed to not have arguments, and the results that popped up did not match what I was looking for. It would be better to document this clearly in your UG, to flag out the commands / tags that do not have arguments.

soc-pe-bot commented 10 months ago

Team's Response

It is documented.

Refer to the UG.

On the "Notes about the command format:" in UG:

image.png

On the implementation of filter command in UG:

image.png

Moreover we downgrade this bug to severity.Low because the information is present in the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]