Documentation

Custom infix operator for concatenating two Docs vertically with an empty line in between.

Concatenate a list of Docs vertically with an empty line in between.

Single backslash.

Basic text-rendering helper function.

Double backslash.

Basic text-rendering helper function.

Variable assignment character ("=").

Basic text-rendering helper function.

Equality character ("==").

Basic text-rendering helper function.

Less than.

Basic text-rendering helper function.

Greater than.

Basic text-rendering helper function.

Less than or equal to.

Basic text-rendering helper function.

Greater than or equal to.

Basic text-rendering helper function.

Dollar sign.

Basic text-rendering helper function.

Asterisk.

Basic text-rendering helper function.

Plus.

Basic text-rendering helper function.

Hat symbol ("^").

Basic text-rendering helper function.

Forward slash.

Basic text-rendering helper function.

Hyphen.

Basic text-rendering helper function.

Underscore.

Basic text-rendering helper function.

Pipe.

Basic text-rendering helper function.

Empty line.

Basic text-rendering helper function.

Square brackets.

Text-rendering helper for wrapping strings with brackets/braces.

Curly braces.

Text-rendering helper for wrapping strings with brackets/braces.

Dot symbol (".")

Text-rendering helper for appending a period/decimal point (dot symbol) or a comma.

Comma (",")

Text-rendering helper for appending a period/decimal point (dot symbol) or a comma.

For wrapping $ on both sides of a Doc.

Wraps in parenthesis.

Basic plaintext (String) wrapping.

Wraps in curly braces.

Basic plaintext (String) wrapping.

Wraps in dollar signs.

Basic plaintext (String) wrapping.

Wraps in square brackets.

Basic plaintext (String) wrapping.

Wraps in angular brackets ("<>").

Basic plaintext (String) wrapping.

Capitalize first letter of string.

Format strings and convert to Doc.

Make first letter lowercase.

Format strings and convert to Doc.

Appends a suffix for a number. Used only on single digit Ints.

Similar to sufx but used on any sized Int.