Safe Haskell	Safe-Inferred

Util.Doc

Description

Utilities for the Doc type.

Synopsis

newtype Doc = Doc Text
pretty :: Pretty.Pretty a => a -> Doc
literal :: Text -> Doc
commas :: [Doc] -> Doc

Documentation

newtype Doc Source #

This is for documentation text. It can contain some simple markdown-like formatting, which may be either be printed directly, or formatted via html_doc.

Constructors

Doc Text

Instances

Instances details

String.IsString Doc Source #
Instance details Defined in Util.Doc Methods fromString :: String.String -> Doc #
Monoid Doc Source #
Instance details Defined in Util.Doc Methods mempty :: Doc # mappend :: Doc -> Doc -> Doc # mconcat :: [Doc] -> Doc #
Semigroup Doc Source #
Instance details Defined in Util.Doc Methods (<>) :: Doc -> Doc -> Doc # sconcat :: NonEmpty Doc -> Doc # stimes :: Integral b => b -> Doc -> Doc #
Show Doc Source #
Instance details Defined in Util.Doc Methods showsPrec :: Int -> Doc -> ShowS # show :: Doc -> String.String # showList :: [Doc] -> ShowS #
Eq Doc Source #
Instance details Defined in Util.Doc Methods (==) :: Doc -> Doc -> Bool # (/=) :: Doc -> Doc -> Bool #
Ord Doc Source #
Instance details Defined in Util.Doc Methods compare :: Doc -> Doc -> Ordering # (<) :: Doc -> Doc -> Bool # (<=) :: Doc -> Doc -> Bool # (>) :: Doc -> Doc -> Bool # (>=) :: Doc -> Doc -> Bool # max :: Doc -> Doc -> Doc # min :: Doc -> Doc -> Doc #
Pretty.Pretty Doc Source #
Instance details Defined in Util.Doc Methods pretty :: Doc -> Text Source # format :: Doc -> Doc0 Source # formatList :: [Doc] -> Doc0 Source #
Serialize.Serialize Doc Source #
Instance details Defined in Util.Doc Methods put :: Putter Doc Source # get :: Serialize.Get Doc Source #
Texts.Textlike Doc Source #
Instance details Defined in Util.Doc Methods toText :: Doc -> Text Source # fromText :: Text -> Doc Source # toString :: Doc -> String.String Source # toByteString :: Doc -> ByteString Source # toLazyByteString :: Doc -> ByteString Source #

pretty :: Pretty.Pretty a => a -> Doc Source #

This probably doesn't belong here, but it's useful in the same contexts as Doc.

literal :: Text -> Doc Source #

commas :: [Doc] -> Doc Source #