search

SelwynAng / pe

0 stars 0 forks source link

Understanding Notations Table is split into 2 #7

Open SelwynAng opened 10 months ago

SelwynAng commented 10 months ago

Screenshot 2023-11-17 at 4.18.34 PM.png

The table row "Items in square brackets" is broken into 2 for the Understanding Notations Table which affects reader's ability to read.

nus-pe-bot commented 10 months ago

Team's Response

Since this is not a diagram being split into two, we feel that it does not hinder the reader:

image.png

As such, we propose to reject this bug report.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response. However, I feel that this should still count as a documentation bug with a Very Low severity. The row of the table is split over 2 pages, and the reader would need to jump back and forth between the two pages to see the content within the same row, which I feel the team should have circumvented by placing a <div style="page-break-after: always;"></div> tag inside the markdown of the Developer Guide, according to the PDF printing instructions, to either shift the row to the next page or shift the entire table to the next page after printing the PDF version. Also, a table can also qualify as diagram as it is not written in a prose form.