Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sample output for help command is cut in half by the page break #1038

Open
nus-pe-bot opened this issue Nov 11, 2022 · 1 comment
Open

Sample output for help command is cut in half by the page break #1038

nus-pe-bot opened this issue Nov 11, 2022 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Nov 11, 2022

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

Having a page break in the middle of an example makes it difficult for a user to follow, especially if it is a printed document.


[original: nus-cs2113-AY2223S1/pe-interim#1033] [original labels: severity.VeryLow type.DocumentationBug]
@Zhai-Yuxin
Copy link
Contributor

Team's Response

"The PDF versions of the UG/DG/PPP should be usable by the target readers, even if not as neat/optimized as the Web versions. For example, margins and page breaks need not be optimized but they should not hinder the reader either. Assume some will occasionally choose the PDF version over the Web version e.g, for printing, offline viewing, annotating etc."

As quoted in the textbook.
The page break does not really affect the readability and understandability of the user.

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants