search

Tempura-Person / pe

0 stars 0 forks source link

Lack of page breaks leads to confusing formatting #9

Open Tempura-Person opened 1 year ago

Tempura-Person commented 1 year ago

image.png

There is a lack of manual page breaks in both the user guide and developer guide, which may confuse the user. In this case, a user might think Diagram 4 refers to the 'Appearance of module tags' section when it is in fact, referring to the diagram at the bottom of the previous page.

image.png

In this case, the tip box is split into 2, which may lead the user to believe they are unrelated to each other.

nus-pe-script commented 1 year ago

Team's Response

Firstly, this should be triaged as a VeryLow severity because it is a cosmetic bug.

Secondly, this is a duplicate of the issue "#3263: UG Example box is split" because both talk about page breaks for coloured boxes.

The 'Original' Bug

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

UG Example box is split

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.

as title - split due to page break

image.png

[original: nus-cs2103-AY2223S2/pe-interim#4309] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for your feedback. However, given that the example box is still clearly readable and does not make the reader use more than necessary effort to read its content, we will have to reject this as we were instructed not to care about such issues. (see image below)

telegram-cloud-document-5-6186094477929613727.jpg

We will take this into consideration for the future.

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.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]