search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Hard to understand in DG pg.15 #4503

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 term "happy path" is taught in the module, but not every reader knows what it means. Perhaps giving a definition will be better.

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

lwj1711 commented 2 years ago

Team's Response

Target audience of the DG is for advanced developers to understand more about our product's system architecture and implementation, and as such assumed to know such terms.

'Happy path' is also easily found on the internet and not some term so niche that you have to take our module to fully comprehend its meaning.

Good suggestion for its definition to be given nevertheless.

Duplicate status (if any):

--