search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Insufficient examples in explanation of clear command in UG #1307

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years ago

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.

In section 3.7 of the UG, Clearing all entries, it is stated that users should use the clear command with caution.

However, it would be nice to have some examples of different contexts of when the target audience should and should not use the command, maybe as an appendix.

This would make the UG more user friendly and clearer as well.

Screenshot (283).png

[original: nus-cs2113-AY2021S2/pe-interim#1307] [original labels: severity.Medium type.DocumentationBug]

RainyCodeWizard commented 3 years ago

Team's Response

With reference to the screenshot you pasted in this issue, we have given an example of when to use the clear command in the 2nd sentence. We deemed that it was unnecessary to include it in the appendix in the UG, as it is sufficiently explained here.

Duplicate status (if any):

--