search

yeozongyao / pe

0 stars 0 forks source link

User guide cut off #20

Open yeozongyao opened 2 months ago

yeozongyao commented 2 months ago

image.png

The user guide is cut off as show in this screenshot. I am unable to read the example usage. Hence, i am assigning this a severity of medium

nus-se-script commented 2 months ago

Team's Response

Severity downgraded as the user can scroll to see what has been cut off.

The 'Original' Bug

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

Example usage cut off in page 8 of UG

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

In page 8 of the UG, the example output is cut off.

[original: nus-cs2113-AY2324S2/pe-interim#1841] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Though it has a cut off in the line, the website looks fine, which means if users would like to see the actual result, they may refer to the online version of the UG. The user could also scroll to the right, as evident from the scroll bar in their pdf viewer.

image.png

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 response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** I disagree that this is not in scope. ![image.png](https://raw.githubusercontent.com/yeozongyao/pe/main/files/ea5be030-ec8a-4a46-bb9b-14501554a527.png) It is clearly stated in the course website that the PE uses the PDF version and that the PDF version should be usable by the target reader. ![image.png](https://raw.githubusercontent.com/yeozongyao/pe/main/files/f8699149-6bcd-4205-86da-7a96a10fecb0.png) This fulfils neither criterias: firstly, it is not a specified issue, secondly, how are readers able to read the UG when the details are missing.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree that is of very low severity. ![image.png](https://raw.githubusercontent.com/yeozongyao/pe/main/files/ea5be030-ec8a-4a46-bb9b-14501554a527.png) It is clearly stated in the course website that the PE uses the PDF version and that the PDF version should be usable by the target reader. ![image.png](https://raw.githubusercontent.com/yeozongyao/pe/main/files/991c4144-0cc2-43e4-97db-0708c6e4a9d1.png) This definitely does not constitute a cosmetic issue because it is not a visual element that I can easily overlook. It is a necessary piece of information that I require when I operate the programme, which is missing and thus affects my usage. Thus bug hovers between a medium and a low. I will go for a low severity. Final decision: Low severity for this documentation bug