search

nus-cs2113-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Too many repetitions #994

Open nus-pe-bot opened 12 months ago

nus-pe-bot commented 12 months 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.

At the very beginning of your UG, you have already mentioned that "Items in square brackets are optional", "All parameters are case-insensitive", and "All categories are case-insensitive". However, in every command and the subcategories, you also repeat those notices, I think this is unnecessary.

Screenshot 2023-11-17 at 17.12.22.png Screenshot 2023-11-17 at 17.12.03.png Screenshot 2023-10-10 at 18.18.18.png

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

spaceman03 commented 12 months ago

Team's Response

Thank you for your recommendation. We included the note section just to remind the users on the format of the command, as we thought it would be useful for the users as they might want to refer to it. However, we appreciate your suggestion and will think of removing the redundant parts.

Duplicate status (if any):

--