nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Command format for delete-an in the summary table of UG is different from that in its designated section #4489

Open nus-pe-bot opened 5 months ago

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


image.png The parameter INDEX is renamed NOTE_INDEX. Based on the definition in the corresponding section for delete-an, INDEX refers to the index number shown in the displayed patient list. The new name NOTE_INDEX apparently has nothing to do with the original definition and this causes confusion.


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

joenus commented 5 months ago

Team's Response

I've decided to assign Rejected this issue instead of assigning NotInScope as the tester did not understand how the system works.

INDEX / NOTE_INDEX refers to the appointment note / appointment record. While the I agree that the consistency can be improved, both portion of the documentation refers to the same thing and the documentation is factually correct.

Screenshot 2024-04-20 at 9.36.50 PM.png

Duplicate status (if any):

--