choowengyan / pe

0 stars 0 forks source link

Improper documentation handling for page break #2

Open choowengyan opened 2 months ago

choowengyan commented 2 months ago

As shown in the screenshot below,General Functions heading is being separated by the page and it is supposed to be together with the headings below, as it hinders readability.

Screenshot 2024-04-19 at 4.14.39 PM.png

Expected: Page break should be enforced, and the General Functionsheading should be placed on the next page for better readability.

nus-se-bot commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

UG is poorly formatted, especially at addMeeting

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 the addMeeting part of User Guide, there is a very noticable gap, with the example extending to the next page although there is a lot of empty space for the message

image.png


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

Their Response to the 'Original' Bug

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

No details provided by team.

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]