| definition: |
align :: Doc -> Doc align d = Doc (OpenNest Align . deDoc d . CloseNest) |
| demand: |
no demanded arguments |
| deterministic: |
deterministic operation |
| documentation: |
--- The document `(align d)` renders document `d with the nesting level --- set to the current column. It is used for example to implement `hang`. --- --- As an example, we will put a document right above another one, --- regardless of the current nesting level: --- --- x $$ y = align (x $$ y) --- test = text "hi" <+> (text "nice" $$ text "world") --- --- which will be layed out as: --- --- hi nice --- world --- --- @param d - a document --- @return document d with the nesting level set to the current column |
| failfree: |
_ |
| indeterministic: |
referentially transparent operation |
| infix: |
no fixity defined |
| iotype: |
{(_) |-> {Doc}}
|
| name: |
align |
| precedence: |
no precedence defined |
| result-values: |
{Doc}
|
| signature: |
Text.PrettyImpl.Doc -> Text.PrettyImpl.Doc |
| solution-complete: |
operation might suspend on free variables |
| terminating: |
yes |
| totally-defined: |
reducible on all ground data terms |