search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Too many low level details in find section #2923

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.

Talking about the CLI syntax, for example "n/ will contain 2 AppointmentNamePredicates , 1 checking for alex, and the other checking for john", is too low level and only becomes confusing for the reader.

Screenshot 2021-04-16 at 3.40.24 PM.png

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

w-yuchen commented 3 years ago

Team's Response

Dear tester, we need to use CLI commands here so we can have some names or values to better explain in detail how the command works. It would be awkward to introduce random magi numbers out of nowhere in the later parts of the DG.

Duplicate status (if any):

--