nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing implementation of EditPatient in DG #2155

Open nus-se-script opened 5 months ago

nus-se-script 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.



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

dayn-1 commented 5 months ago

Team's Response

Hello, thank you for raising this issue.

As mentioned in the bug report, the implementation logic for editAppt is present. The general implementation logic for editPatient, at the structural level as covered in the DG, is similar to that of editAppt.

Based on the requirements defined by the teaching team previously:

Screenshot 2024-04-21 at 1.13.04 AM.png

There is no need to document every feature. The team decided that given the similarities of editAppt and editPatient, developers that understand how editAppt works will find that editPatient works similarly. In fact, editPatient is simpler than editAppt. There is not much value in including the implementation of editPatient on top of editAppt. The learning curve is not steep.

Hope this clarifies.

Response rejected.

In any case, the severity was dropped to severity.Low as at best, it is a minor inconvenience.

Duplicate status (if any):

--