diff options
| author | RyanGlScott <ryan.gl.scott@gmail.com> | 2015-12-07 11:06:23 +0100 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2015-12-07 11:06:30 +0100 |
| commit | 3ea4fb746a4dbd9248586ed212c7afccb2df3338 (patch) | |
| tree | c6e325ef667617f9a3d9197d7a6e870f5a82e09e /libraries/template-haskell | |
| parent | f5127c81ccb4d65f794b2b43fd3ad9b59c9a89d1 (diff) | |
| download | haskell-3ea4fb746a4dbd9248586ed212c7afccb2df3338.tar.gz | |
Documentation: escape characters in template-haskell Haddocks
Reviewers: hvr, austin, goldfire, bgamari
Reviewed By: goldfire, bgamari
Subscribers: thomie
Differential Revision: https://phabricator.haskell.org/D1578
Diffstat (limited to 'libraries/template-haskell')
| -rw-r--r-- | libraries/template-haskell/Language/Haskell/TH/Syntax.hs | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/libraries/template-haskell/Language/Haskell/TH/Syntax.hs b/libraries/template-haskell/Language/Haskell/TH/Syntax.hs index 4d30a9df14..ca6219ea91 100644 --- a/libraries/template-haskell/Language/Haskell/TH/Syntax.hs +++ b/libraries/template-haskell/Language/Haskell/TH/Syntax.hs @@ -908,7 +908,7 @@ nameBase (Name occ _) = occString occ -- -- ==== __Examples__ -- --- >>> nameModule ''Data.Either.Either" +-- >>> nameModule ''Data.Either.Either -- Just "Data.Either" -- >>> nameModule (mkName "foo") -- Nothing @@ -923,7 +923,7 @@ nameModule _ = Nothing -- -- ==== __Examples__ -- --- >>> namePackage ''Data.Either.Either" +-- >>> namePackage ''Data.Either.Either -- Just "base" -- >>> namePackage (mkName "foo") -- Nothing @@ -1343,10 +1343,10 @@ data Lit = CharL Char -- | Pattern in Haskell given in @{}@ data Pat - = LitP Lit -- ^ @{ 5 or 'c' }@ + = LitP Lit -- ^ @{ 5 or \'c\' }@ | VarP Name -- ^ @{ x }@ | TupP [Pat] -- ^ @{ (p1,p2) }@ - | UnboxedTupP [Pat] -- ^ @{ (# p1,p2 #) }@ + | UnboxedTupP [Pat] -- ^ @{ (\# p1,p2 \#) }@ | ConP Name [Pat] -- ^ @data T1 = C1 t1 t2; {C1 p1 p1} = e@ | InfixP Pat Name Pat -- ^ @foo ({x :+ y}) = e@ | UInfixP Pat Name Pat -- ^ @foo ({x :+ y}) = e@ @@ -1376,7 +1376,7 @@ data Clause = Clause [Pat] Body [Dec] data Exp = VarE Name -- ^ @{ x }@ | ConE Name -- ^ @data T1 = C1 t1 t2; p = {C1} e1 e2 @ - | LitE Lit -- ^ @{ 5 or 'c'}@ + | LitE Lit -- ^ @{ 5 or \'c\'}@ | AppE Exp Exp -- ^ @{ f x }@ | InfixE (Maybe Exp) Exp (Maybe Exp) -- ^ @{x + y} or {(x+)} or {(+ x)} or {(+)}@ @@ -1393,10 +1393,10 @@ data Exp | ParensE Exp -- ^ @{ (e) }@ -- -- See "Language.Haskell.TH.Syntax#infix" - | LamE [Pat] Exp -- ^ @{ \ p1 p2 -> e }@ - | LamCaseE [Match] -- ^ @{ \case m1; m2 }@ + | LamE [Pat] Exp -- ^ @{ \\ p1 p2 -> e }@ + | LamCaseE [Match] -- ^ @{ \\case m1; m2 }@ | TupE [Exp] -- ^ @{ (e1,e2) } @ - | UnboxedTupE [Exp] -- ^ @{ (# e1,e2 #) } @ + | UnboxedTupE [Exp] -- ^ @{ (\# e1,e2 \#) } @ | CondE Exp Exp Exp -- ^ @{ if e1 then e2 else e3 }@ | MultiIfE [(Guard, Exp)] -- ^ @{ if | g1 -> e1 | g2 -> e2 }@ | LetE [Dec] Exp -- ^ @{ let x=e1; y=e2 in e3 }@ @@ -1470,7 +1470,7 @@ data Dec | InfixD Fixity Name -- ^ @{ infix 3 foo }@ -- | pragmas - | PragmaD Pragma -- ^ @{ {\-# INLINE [1] foo #-\} }@ + | PragmaD Pragma -- ^ @{ {\-\# INLINE [1] foo \#-\} }@ -- | data families (may also appear in [Dec] of 'ClassD' and 'InstanceD') | DataFamilyD Name [TyVarBndr] @@ -1590,7 +1590,7 @@ data Type = ForallT [TyVarBndr] Cxt Type -- ^ @forall \<vars\>. \<ctxt\> -> \<t -- See Note [Representing concrete syntax in types] | TupleT Int -- ^ @(,), (,,), etc.@ - | UnboxedTupleT Int -- ^ @(#,#), (#,,#), etc.@ + | UnboxedTupleT Int -- ^ @(\#,\#), (\#,,\#), etc.@ | ArrowT -- ^ @->@ | EqualityT -- ^ @~@ | ListT -- ^ @[]@ |