search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

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

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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 commented 1 year ago

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):

--