search

damiwee / pe

0 stars 0 forks source link

Misleading command in UG documentation #7

Open damiwee opened 4 months ago

damiwee commented 4 months ago

Perhaps consider fixing the documentation. Attached are the screenshots from running the command and UG.

image.png

image.png

soc-pe-bot commented 4 months ago

Team's Response

The sentence already made this clear by stating to use the right /item: filter respectively.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: With reference to the full screenshot below, no where does it mention that you can't list the history of multiple types at once (excluding gym and run using the workout keyword). The screenshot in the bug report suggests to users that you can do so using a command format similar history /item:run/gym, when in actuality, you can't. Additionally, one might also interpret history /item:run/gym to output the same thing as history /item: workout. This might create confusion.

image.png

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is neither a cosmetic nor grammar issue. It is an inaccurate/ poorly phrased documentation bug that might confuse and bring inconvenience. ![image.png](https://raw.githubusercontent.com/damiwee/pe/main/files/00a2e089-61a7-433c-9ecf-0d05c4412192.png)