nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Ambiguity of the header "Tracing close contacts" #4183

Open nus-pe-bot opened 7 months ago

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


The header is not a good representative of what the command trace is doing. As a user, I would be confused because of how the header says "tracing close contacts" but it is instead tracing people of the same appointments. Screenshot 2024-04-19 at 5.22.17 PM.png


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

chengjunyuan commented 7 months ago

Team's Response

Two patients which have an overlapping appointment are by definition close contacts. Hence, the header can be considered a good representation of what the trace command does.

Duplicate status (if any):

--