Cabal-3.0.0.0: doc/API/Cabal/Distribution-FieldGrammar-Pretty.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Distribution.FieldGrammar.Pretty</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-3.0.0.0: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Distribution.FieldGrammar.Pretty</p></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">data</span> <a href="#t:PrettyFieldGrammar">PrettyFieldGrammar</a> s a</li><li class="src short"><a href="#v:prettyFieldGrammar">prettyFieldGrammar</a> :: <a href="Distribution-CabalSpecVersion.html#t:CabalSpecVersion" title="Distribution.CabalSpecVersion">CabalSpecVersion</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> s -> [<a href="Distribution-Fields-Pretty.html#t:PrettyField" title="Distribution.Fields.Pretty">PrettyField</a> ()]</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:PrettyFieldGrammar" class="def">PrettyFieldGrammar</a> s a <a href="#t:PrettyFieldGrammar" class="selflink">#</a></p><div class="subs instances"><details id="i:PrettyFieldGrammar" open="open"><summary>Instances</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:PrettyFieldGrammar:FieldGrammar:1"></span> <a href="Distribution-FieldGrammar-Class.html#t:FieldGrammar" title="Distribution.FieldGrammar.Class">FieldGrammar</a> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a></span> <a href="#t:PrettyFieldGrammar" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><details id="i:id:PrettyFieldGrammar:FieldGrammar:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Distribution-FieldGrammar-Pretty.html">Distribution.FieldGrammar.Pretty</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:blurFieldGrammar">blurFieldGrammar</a> :: <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> a b -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> b c -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> a c <a href="#v:blurFieldGrammar" class="selflink">#</a></p><p class="src"><a href="#v:uniqueFieldAla">uniqueFieldAla</a> :: (<a href="Distribution-Parsec.html#t:Parsec" title="Distribution.Parsec">Parsec</a> b, <a href="Distribution-Pretty.html#t:Pretty" title="Distribution.Pretty">Pretty</a> b, <a href="Distribution-Compat-Newtype.html#t:Newtype" title="Distribution.Compat.Newtype">Newtype</a> a b) => <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> (a -> b) -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:uniqueFieldAla" class="selflink">#</a></p><p class="src"><a href="#v:booleanFieldDef">booleanFieldDef</a> :: <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s <a href="Distribution-Compat-Prelude-Internal.html#t:Bool" title="Distribution.Compat.Prelude.Internal">Bool</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:Bool" title="Distribution.Compat.Prelude.Internal">Bool</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s <a href="Distribution-Compat-Prelude-Internal.html#t:Bool" title="Distribution.Compat.Prelude.Internal">Bool</a> <a href="#v:booleanFieldDef" class="selflink">#</a></p><p class="src"><a href="#v:optionalFieldAla">optionalFieldAla</a> :: (<a href="Distribution-Parsec.html#t:Parsec" title="Distribution.Parsec">Parsec</a> b, <a href="Distribution-Pretty.html#t:Pretty" title="Distribution.Pretty">Pretty</a> b, <a href="Distribution-Compat-Newtype.html#t:Newtype" title="Distribution.Compat.Newtype">Newtype</a> a b) => <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> (a -> b) -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s (<a href="Distribution-Compat-Prelude-Internal.html#t:Maybe" title="Distribution.Compat.Prelude.Internal">Maybe</a> a) -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s (<a href="Distribution-Compat-Prelude-Internal.html#t:Maybe" title="Distribution.Compat.Prelude.Internal">Maybe</a> a) <a href="#v:optionalFieldAla" class="selflink">#</a></p><p class="src"><a href="#v:optionalFieldDefAla">optionalFieldDefAla</a> :: (<a href="Distribution-Parsec.html#t:Parsec" title="Distribution.Parsec">Parsec</a> b, <a href="Distribution-Pretty.html#t:Pretty" title="Distribution.Pretty">Pretty</a> b, <a href="Distribution-Compat-Newtype.html#t:Newtype" title="Distribution.Compat.Newtype">Newtype</a> a b, <a href="Distribution-Compat-Prelude-Internal.html#t:Eq" title="Distribution.Compat.Prelude.Internal">Eq</a> a) => <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> (a -> b) -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s a -> a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:optionalFieldDefAla" class="selflink">#</a></p><p class="src"><a href="#v:freeTextField">freeTextField</a> :: <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s (<a href="Distribution-Compat-Prelude-Internal.html#t:Maybe" title="Distribution.Compat.Prelude.Internal">Maybe</a> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>) -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s (<a href="Distribution-Compat-Prelude-Internal.html#t:Maybe" title="Distribution.Compat.Prelude.Internal">Maybe</a> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>) <a href="#v:freeTextField" class="selflink">#</a></p><p class="src"><a href="#v:freeTextFieldDef">freeTextFieldDef</a> :: <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> <a href="#v:freeTextFieldDef" class="selflink">#</a></p><p class="src"><a href="#v:monoidalFieldAla">monoidalFieldAla</a> :: (<a href="Distribution-Parsec.html#t:Parsec" title="Distribution.Parsec">Parsec</a> b, <a href="Distribution-Pretty.html#t:Pretty" title="Distribution.Pretty">Pretty</a> b, <a href="Distribution-Compat-Semigroup.html#t:Monoid" title="Distribution.Compat.Semigroup">Monoid</a> a, <a href="Distribution-Compat-Newtype.html#t:Newtype" title="Distribution.Compat.Newtype">Newtype</a> a b) => <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> (a -> b) -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:monoidalFieldAla" class="selflink">#</a></p><p class="src"><a href="#v:prefixedFields">prefixedFields</a> :: <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> <a href="Distribution-Compat-Lens.html#t:ALens-39-" title="Distribution.Compat.Lens">ALens'</a> s [(<a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>, <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>)] -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s [(<a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>, <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a>)] <a href="#v:prefixedFields" class="selflink">#</a></p><p class="src"><a href="#v:knownField">knownField</a> :: <a href="Distribution-Fields-Field.html#t:FieldName" title="Distribution.Fields.Field">FieldName</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s () <a href="#v:knownField" class="selflink">#</a></p><p class="src"><a href="#v:hiddenField">hiddenField</a> :: <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:hiddenField" class="selflink">#</a></p><p class="src"><a href="#v:deprecatedSince">deprecatedSince</a> :: <a href="Distribution-CabalSpecVersion.html#t:CabalSpecVersion" title="Distribution.CabalSpecVersion">CabalSpecVersion</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:deprecatedSince" class="selflink">#</a></p><p class="src"><a href="#v:removedIn">removedIn</a> :: <a href="Distribution-CabalSpecVersion.html#t:CabalSpecVersion" title="Distribution.CabalSpecVersion">CabalSpecVersion</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:removedIn" class="selflink">#</a></p><p class="src"><a href="#v:availableSince">availableSince</a> :: <a href="Distribution-CabalSpecVersion.html#t:CabalSpecVersion" title="Distribution.CabalSpecVersion">CabalSpecVersion</a> -> a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:availableSince" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:PrettyFieldGrammar:Functor:2"></span> <a href="Distribution-Compat-Prelude-Internal.html#t:Functor" title="Distribution.Compat.Prelude.Internal">Functor</a> (<a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s)</span> <a href="#t:PrettyFieldGrammar" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><details id="i:id:PrettyFieldGrammar:Functor:2"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Distribution-FieldGrammar-Pretty.html">Distribution.FieldGrammar.Pretty</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:fmap">fmap</a> :: (a -> b) -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b <a href="#v:fmap" class="selflink">#</a></p><p class="src"><a href="#v:-60--36-">(<$)</a> :: a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:-60--36-" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:PrettyFieldGrammar:Applicative:3"></span> <a href="Distribution-Compat-Prelude-Internal.html#t:Applicative" title="Distribution.Compat.Prelude.Internal">Applicative</a> (<a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s)</span> <a href="#t:PrettyFieldGrammar" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><details id="i:id:PrettyFieldGrammar:Applicative:3"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Distribution-FieldGrammar-Pretty.html">Distribution.FieldGrammar.Pretty</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:pure">pure</a> :: a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:pure" class="selflink">#</a></p><p class="src"><a href="#v:-60--42--62-">(<*>)</a> :: <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s (a -> b) -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b <a href="#v:-60--42--62-" class="selflink">#</a></p><p class="src"><a href="#v:liftA2">liftA2</a> :: (a -> b -> c) -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s c <a href="#v:liftA2" class="selflink">#</a></p><p class="src"><a href="#v:-42--62-">(*>)</a> :: <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b <a href="#v:-42--62-" class="selflink">#</a></p><p class="src"><a href="#v:-60--42-">(<*)</a> :: <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s b -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a <a href="#v:-60--42-" class="selflink">#</a></p></div></details></td></tr></table></details></div></div><div class="top"><p class="src"><a id="v:prettyFieldGrammar" class="def">prettyFieldGrammar</a> :: <a href="Distribution-CabalSpecVersion.html#t:CabalSpecVersion" title="Distribution.CabalSpecVersion">CabalSpecVersion</a> -> <a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a> s a -> s -> [<a href="Distribution-Fields-Pretty.html#t:PrettyField" title="Distribution.Fields.Pretty">PrettyField</a> ()] <a href="#v:prettyFieldGrammar" class="selflink">#</a></p><div class="doc"><p>We can use <code><a href="Distribution-FieldGrammar-Pretty.html#t:PrettyFieldGrammar" title="Distribution.FieldGrammar.Pretty">PrettyFieldGrammar</a></code> to pp print the <code>s</code>.</p><p><em>Note:</em> there is not trailing <code>($+$ text "")</code>.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.22.0</p></div></body></html>