timiditi / pe

0 stars 0 forks source link

Text cut-off in page 15 of DG #9

Open timiditi opened 2 years ago

timiditi commented 2 years ago

Text is cut off under the implementation description of the Find Feature.

image.png

Likely to hinder the reader's ability to understand the implementation regarding handling multiple keywords within categories.

nus-pe-bot commented 2 years ago

Team's Response

A duplicate of #4288

The description is meant to end at "is used to create a conjunctive search." Hence the severity is decreased to low as the difference does not affect the understanding of the reader. It only hinders the reader a bit as stated.

The 'Original' Bug

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

Incomplete Description

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


[original: nus-cs2103-AY2122S1/pe-interim#4229] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Accepted.

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: [replace this with your explanation]


:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: I disagree with the decision to rate this bug as severity.Low.

Firstly, this issue will still be noticed and hence cause some level of initial confusion to almost all readers of this guide, and should therefore be categorised as severity.Medium at the very least, as it fits that criteria.

To add to that, even if there is indeed no loss in information as you stated, this is not something that a reader would know, and hence they would face a considerable hindrance when reading, as it is reasonable that they may assume that they lack a key piece of information. As such, it can be argued that the severity should be marked as High.