YamlParse.Applicative.Pretty

Documentation

prettySchemaDoc :: forall o i. YamlSchema o => Text

Render pretty documentation about the yamlSchema of a type

This is meant for humans. The output may look like YAML but it is not.

prettyParserDoc :: Parser i o -> Text

Render pretty documentation about a parser

This is meant for humans. The output may look like YAML but it is not.

prettySchema :: Schema -> Text

Render a schema as pretty text.

This is meant for humans. The output may look like YAML but it is not.

newtype Comments

A list of comments

Constructors

Comments

Fields

• commentsList :: [Doc ()]

Instances

Show Comments

Defined in YamlParse.Applicative.Pretty

Methods

showsPrec :: Int -> Comments -> ShowS

show :: Comments -> String

showList :: [Comments] -> ShowS

Semigroup Comments

Defined in YamlParse.Applicative.Pretty

Methods

(<>) :: Comments -> Comments -> Comments

sconcat :: NonEmpty Comments -> Comments

stimes :: Integral b => b -> Comments -> Comments

Monoid Comments

Defined in YamlParse.Applicative.Pretty

Methods

mempty :: Comments

mappend :: Comments -> Comments -> Comments

mconcat :: [Comments] -> Comments

emptyComments :: Comments

No comments

comment :: Text -> Comments

A raw text as comments

schemaDoc :: Schema -> Doc ()

Prettyprint a Schema