germainelee02 / pe

0 stars 0 forks source link

Unsure what the word keyword refer to here #18

Open germainelee02 opened 1 year ago

germainelee02 commented 1 year ago

Not clear what KEYWORD refers to. This can be very confusing for first time users.

Screenshot 2023-04-14 at 3.14.57 PM.png

soc-pe-bot commented 1 year ago

Team's Response

This DocumentationBug is rejected, as the format is covered in "Notes about the command format" under "Features", where "Keyword" is referenced multiple times, with ample explanation on what they refer to. Additionally, the information provided in the screenshot is rather unambiguous, as such the issue the tester has is not altogether clear.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Screenshot 2023-04-18 at 12.55.18 PM.png

I went to find your "Notes about Command Format" again to make sure that I was not being gaslit.

While you did mention upper and lower casing, you did not explicitly state what keywords are.

When you do syntax highlighting on the word 'keyword', like KEYWORD, we expect that there is an explicit format for it. In you "Notes about Command Format", however, you did not explicitly do that. Hence, I was very confused. You should be saying the KEYWORDS can be NAME, PHONE, etc.

For example, when I say "Can you please do the DISHES", you would expect that I would explicitly state somewhere that DISHES meant plates, bowls, and spoons.