search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistency in UG regarding `Filter by salaries` #146

Open nus-pe-bot opened 6 months ago

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

Note the following in "Filter by salaries"

image.png

Compared to another "Filter" documentation:

image.png

Note how there lacks a line which explicitly mentions "Refer to parameter constraints table for more details on acceptable inputs for Salaries", instead listing it as a field in "Valid salary range".

This is an inconsistency across the way the various fields are listed; it should be ordered similarly across the various filter fields.

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

dabzpengu commented 6 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--