|
definition:
|
hang :: Int -> Doc -> Doc
hang i x = align (nest i x)
|
|
demand:
|
no demanded arguments
|
|
deterministic:
|
deterministic operation
|
|
documentation:
|
--- The combinator `hang` implements hanging indentation.
--- The document `(hang i d)` renders document `d` with a nesting level set
--- to the current column plus `i`. The following example uses hanging
--- indentation for some text:
---
--- test = hang 4
--- (fillSep
--- (map text
--- (words "the hang combinator indents these words !")))
---
--- Which lays out on a page with a width of 20 characters as:
---
--- the hang combinator
--- indents these
--- words !
---
--- The hang combinator is implemented as:
---
--- hang i x = align (nest i x)
---
--- @param i - an integer which increases the indentation level
--- @param d - a document
--- @return document d with an indentation level set to the current column plus i
|
|
failfree:
|
(_, _)
|
|
indeterministic:
|
referentially transparent operation
|
|
infix:
|
no fixity defined
|
|
iotype:
|
{(_,_) |-> {Doc}}
|
|
name:
|
hang
|
|
precedence:
|
no precedence defined
|
|
result-values:
|
{Doc}
|
|
signature:
|
Prelude.Int -> Text.PrettyImpl.Doc -> Text.PrettyImpl.Doc
|
|
solution-complete:
|
operation might suspend on free variables
|
|
terminating:
|
yes
|
|
totally-defined:
|
reducible on all ground data terms
|