search

cookiedan42 / pe

0 stars 0 forks source link

Page break in between example header and example #13

Open cookiedan42 opened 3 years ago

cookiedan42 commented 3 years ago

On page 13 of user guide, the only example has been orphaned to page 14

image.png

nus-pe-bot commented 3 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Formatting bug

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

Very minor issue but you could have brought the headers to the next page to improve readability. There are more instances like this in the UG

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

Their Response to the 'Original' Bug

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

This does not affect readability. According to the CS2103 website, extra white space is not considered as a bug unless it hinders the reader. The white space here is between lines, it does not cut through words, so it does not decrease the reader's understanding.

Screenshot 2021-11-13 at 6.15.39 PM.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: Diagram being orphaned is different from example being orphaned

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Single example on next page might be missed by reader