search

nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Wrong labeling in UG which confuses the reader #2010

Open nus-pe-bot opened 2 years ago

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

image.png

The user guide mentions the above symbol/syntax for formatting.

image.png But all find commands have the following symbol/syntax, which is very confusing because it doesn't seem like as if any unwanted behaviour is occurring that would be detriment to my experience, but rather, is this not additional information that may be useful for the reader to know?

[original: nus-cs2103-AY2122S2/pe-interim#1997] [original labels: severity.Low type.DocumentationBug]

kashing555 commented 2 years ago

Team's Response

We agree with your view that a different symbol should be used. However, we do not think that this issue warrants a low severity as it does not detriment your experience as you have mentioned.

Duplicate status (if any):

--