tau-bar / pe

0 stars 0 forks source link

INDEX is not stated to be one-indexed in Archive an appointment section. #16

Open tau-bar opened 2 years ago

tau-bar commented 2 years ago

Expected:

• Expected Behaviour: Index to be stated as one-indexed, like in other sections.

Actual:

• Actual Behaviour: Not stated to be one-indexed.

• Why that severity? Low, as might cause users inconvenience should they try index 0 due to lack of documentation, but rare occurrence.

Steps to reproduce:

  1. Go to archive an appointment.
  2. Compare to delete a patient.

Screenshots:

Screenshot 2021-11-12 at 5.19.59 PM.png

Screenshot 2021-11-12 at 5.20.06 PM.png

nus-pe-bot commented 2 years ago

Team's Response

As stated in the UG Bug guidelines, explanations that are unnecessarily long are considered bugs.

As pointed out by the tester in the second screenshot in his/her/their issue, we have used INDEX before in the Delete Patient section and specified one-index. We find it irrelevant to mention and repeat it again in our UG. Hence, we are rejecting this bug.

Screenshot 2021-11-13 at 2.02.20 PM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: ### Response I disagree. This is not unnecessary repetition. For the developers to put 'one-indexed' at only a few specific functions, it might cause the reader to think that only those functions are one-indexed.

Rationale

  1. The developer team claims that the omission of the 'one-indexed' was to prevent unnecessary repetition. However, they did not just put 'one-indexed' once, they put it multiple times in different functions (shown in evidence section). Therefore, this is not an omission of unnecessary details, as they did repeat it multiple times, and did not put it in only some functions.

  2. The developer team specifically put one-indexed at only a few functions, and not at others. While it might just be an oversight by the writers, as a reader, this could cause me an inconvenience, as I might think that only a few functions are one-indexed. It is not stated anywhere in the UG that all the functions are one-indexed, therefore it is not unreasonable for me to think that only a few functions are one-indexed. As mentioned in the module website, this causes a minor inconvenience to readers, therefore this is classified as a severity.Low bug.

Evidence

Explanation for what constitutes a severity.Low bug:
Screenshot 2021-11-17 at 7.10.36 PM.png

Example 1 of non-omission:
Screenshot 2021-11-17 at 7.14.12 PM.png

Example 2 of non-omission:
Screenshot 2021-11-17 at 7.14.55 PM.png

Example 3 of non-omission:
Screenshot 2021-11-17 at 7.14.38 PM.png