KhoonSun47 / pe

0 stars 0 forks source link

Lack Of Example for Feature "Adding Date To Notes" #13

Open KhoonSun47 opened 4 months ago

KhoonSun47 commented 4 months ago

Steps to reproduce:

Actual Output: image.png

Expected Output/Suggestion: There should be example such as "note 1 /note Likes to swim /date true"

nus-pe-bot commented 4 months ago

Team's Response

The format of the note command is clearly stated in the UG.

I believe that providing an example command is a matter of convenience, and not a documentation bug because it did not mislead the user by claiming non-existent functionalities exists.

In fact, the one could copy the sample format note Index /note <Note> /date Flag and simply replace <Note> and Flag with their desired parameters.

However, I do believe that this is an oversight on my part, as other places in our documentation does provide sample commands for the ease of testing.

If given a chance to improve documentation, I will be adding more sample commands to commands that does not have them.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]