search

pranav-ganesh / pe

0 stars 0 forks source link

Formatting bug DG #31

Open pranav-ganesh opened 2 years ago

pranav-ganesh commented 2 years ago

image.png

The word recipes could have been moved to the previous page or the whole row could have been moved to the next page to improve readability. Minor bug

nus-pe-bot commented 2 years ago

Team's Response

Similar to other issues about page breaks, this does not affect readability of any of the words and content.

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: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I agree with the team that the second bug (named 'Formatting bug') is not actually a bug since the extra white space doesn't hinder the reader in any way.

But in the case of the first bug (named 'Formatting bug DG'), the sentence is split across two pages. This hinders the reader and causes minor inconvenience unlike the previous bug.

Here is one of the possible documentation bugs mentioned in the website:

image.png

Similar to how diagrams that are split between pages are considered bugs, I believe that the sentences/phrases that split/cut across pages should be counted as bugs as they cause minor inconvenience by decreasing readability. The team could have easily resolved this by moving the whole row to the next page to improve readability.

Therefore, this is classified as a bug with very low severity.