search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Better clarity for Search #570

Open nus-se-script opened 5 months ago

nus-se-script commented 5 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.

Description

Clarity for Search parameter RANGE could be improved: explicit state what RANGE parameters there are.

eg RANGE refers to any of these parameters: QUANTITY_RANGE, COST_PRICE_RANGE, SALE_PRICE_RANGE, EXPIRY_DATE_RANGE Especially for COST_PRICE_RANGE where the line break in UG may affect reader to miss out that this is a possible RANGE parameter (see below)

Actual

image.png

[original: nus-cs2113-AY2324S2/pe-interim#650] [original labels: type.DocumentationBug severity.VeryLow]

nkotaa commented 5 months ago

Team's Response

Thank you for the explanation. I can see how that might result in some ambiguity.

Duplicate status (if any):

--