SelwynAng / pe

0 stars 0 forks source link

Command Parameter Heading not on same page as the table #8

Open SelwynAng opened 9 months ago

SelwynAng commented 9 months ago

Screenshot 2023-11-17 at 5.19.21 PM.png

Under the "Interview Management Features", the "Command Parameter" heading is not on the same page as the table itself which affects readability.

nus-se-bot commented 9 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.

Screenshot 2023-11-22 at 10.19.54 PM.png

According to this screenshot of the paragraph, I feel that there is "too much white padding" which can potentially hinder the reader. It also makes sense that the header of a section should be on a fresh page. In my opinion, the team could have easily circumvented this issue 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 shift the heading to the next page after printing the PDF version.

It would be hard for the user to refer to the Command Parameters as a whole if they want to print it out as reference too and I think that this should qualify as a documentation bug as it reduces the professionalism of the guide.