Lack Of Example for Feature "Adding Date To Notes"

[nus-se-script]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

Steps to reproduce:

• There is no example given in both UG and DG for the feature 'Adding Date To Notes", it is hard for both users and developers to test the feature.

Actual Output:

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

---

_{[original: nus-cs2103-AY2324S2/pe-interim#266] [original labels: severity.Low type.DocumentationBug]}

[lihaoquan]

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.

Duplicate status (if any):

--