search

Rishit02 / pe

0 stars 0 forks source link

UG command summary does not have examples #15

Open Rishit02 opened 7 months ago

Rishit02 commented 7 months ago

image.png

Some commands are lacking examples which can be troublesome for the user

soc-pe-bot commented 7 months ago

Team's Response

If users would like to see examples of how to use these commands, we provide examples in the sections of the UG dedicated to those commands.

https://ay2324s2-cs2103t-f14-1.github.io/tp/UserGuide.html#4-2-3-updating-a-note-note

https://ay2324s2-cs2103t-f14-1.github.io/tp/UserGuide.html#4-2-5-getting-reminders-reminder

The command summary tables mostly serve to give an overview to our available commands. In the future we will can add more simple examples to the table as well.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: A command summary table should include a summary of all available commands. This seems like an oversight that should've been fixed earlier. Moreover, this could hinder the user that is trying to quickly find the exact command that they want only to find them missing. I believe that this is a documentation bug as valuable information is missing from the UG where it should be available.