format: document structural box quirk

master
octachron 2020-05-29 16:08:16 +02:00
parent b6ba1823c0
commit 99f0910081
1 changed files with 2 additions and 1 deletions

View File

@ -150,7 +150,8 @@ val open_box : int -> unit
A break hint splits the line if there is no more room on the line to
print the remainder of the box.
Within this box, the pretty-printer emphasizes the box structure: a break
Within this box, the pretty-printer emphasizes the box structure:
if a structural box does not fit fully on a simple line, a break
hint also splits the line if the splitting ``moves to the left''
(i.e. the new line gets an indentation smaller than the one of the current
line).