search

yyccbb / pe

0 stars 0 forks source link

Definition of patient index and index are repeated for edit-an #12

Open yyccbb opened 5 months ago

yyccbb commented 5 months ago

image.png

The definitions are repeated and inaccurate.

nus-pe-script commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

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

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 edit-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#4995] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

This is an oversight on our part, hence Accepted.

However, the severity has been assigned to Low as it is unlikely to affect normal operations of the product, and NOTE_INDEX should be intuitive enough for users to know that the index parameter here refers to the note's index.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: image.png

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]