VisnuRavi / pe

0 stars 0 forks source link

DG sections all grouped together #14

Open VisnuRavi opened 3 years ago

VisnuRavi commented 3 years ago

The DG sections of unrelated components all seems to be grouped together, instead of being separated by whitespace or pages, making it difficult for a reader to read and know the start and the end of a section. Given below are a few examples

image.png

image.png

image.png

nus-pe-bot commented 3 years ago

Team's Response

Duplicate of the other issue.

This is clearly a veryLow severity bug, if it can even be considered one.

It is the reader’s personal preference of the styling of the DG.

The intended medium for viewing the UG / DG is through a web browser, but it has to be printed to a pdf for the intents and purposes of testing. On the web browser, there are no page breaks and printing to PDF, leaves it up to the printing to decide the areas to break the pages and it is not left up to us to decide.

The 'Original' Bug

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

DG sections being split between pages

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.


In many instances, the sections were split between 2 pages, making it less readable, here are a few examples.

image.png

image.png

image.png


[original: nus-cs2103-AY2021S2/pe-interim#2472] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

This is clearly a veryLow severity bug, if it can even be considered one.

It is the reader's personal preference of the styling of the DG.

The intended medium for viewing the UG / DG is through a web browser, but it has to be printed to a pdf for the intents and purposes of testing. On the web browser, there are no page breaks and printing to PDF, leaves it up to the printing to decide the areas to break the pages and it is not left up to us to decide.

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: This is different, as the previous bug is about sections being split over pages with much whitespace in between. However, in this bug, the sections are grouped together, making it harder to read.


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: We are supposed to report bugs on the PDF version. Having the sections grouped together makes it hard for the reader to differentiate the different sections, making it harder to read.


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.High]

Reason for disagreement: A low may be more appropriate, as there will be users who are inconvenienced by the DG being hard to read.