diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -9,3 +9,6 @@ ![BSD3 license](https://img.shields.io/badge/license-BSD3-blue.svg) `xml-html-qq` provides quasi-quoters for XML and HTML `Document`s. + +For documentation and usage examples, see the +[documentation](https://hackage.haskell.org/package/xml-html-qq) on Hackage. diff --git a/src/Text/HTML/QQ.hs b/src/Text/HTML/QQ.hs --- a/src/Text/HTML/QQ.hs +++ b/src/Text/HTML/QQ.hs @@ -47,7 +47,7 @@ -- -- Here's a simple example of using it: -- --- >>> [html||] +-- >>> [html||] :: Document -- Document {documentPrologue = Prologue {prologueBefore = [], prologueDoctype = Nothing, prologueAfter = []}, documentRoot = Element {elementName = Name {nameLocalName = "html", nameNamespace = Nothing, namePrefix = Nothing}, elementAttributes = fromList [], elementNodes = []}, documentEpilogue = []} -- -- Internally, this function is using the @@ -79,5 +79,10 @@ -- | This function is the same as 'html', but doesn't allow variable -- interpolation or control statements. It also produces expressions of type -- 'Document'. +-- +-- Here's a simple example of using it: +-- +-- >>> [htmlRaw||] :: Document +-- Document ... htmlRaw :: QuasiQuoter htmlRaw = createExpQuasiQuoter $ lift . parseLT . pack diff --git a/src/Text/XML/QQ.hs b/src/Text/XML/QQ.hs --- a/src/Text/XML/QQ.hs +++ b/src/Text/XML/QQ.hs @@ -64,7 +64,7 @@ -- -- Here's a simple example of using it: -- --- >>> [xml||] +-- >>> [xml||] :: Either SomeException Document -- Right (Document {documentPrologue = Prologue {prologueBefore = [], prologueDoctype = Nothing, prologueAfter = []}, documentRoot = Element {elementName = Name {nameLocalName = "html", nameNamespace = Nothing, namePrefix = Nothing}, elementAttributes = fromList [], elementNodes = []}, documentEpilogue = []}) -- -- Internally, this function is using the @@ -99,8 +99,13 @@ -- If your input string cannot be parsed into a valid 'Document', an error will -- be thrown at runtime with 'error'. -- --- This function is nice to use in GHCi or tests, but should not be used in +-- This function is nice to use in GHCi or tests, but should __NOT__ be used in -- production code. +-- +-- Here's a simple example of using it: +-- +-- >>> [xmlUnsafe||] :: Document +-- Document ... xmlUnsafe :: QuasiQuoter xmlUnsafe = createExpQuasiQuoter $ \string -> @@ -114,6 +119,13 @@ -- -- An error will be thrown at compile-time if the input string cannot be parsed -- into a 'Document'. +-- +-- Unlike 'xmlUnsafe', this function is safe to use in production code. +-- +-- Here's a simple example of using it: +-- +-- >>> [xmlRaw||] :: Document +-- Document ... xmlRaw :: QuasiQuoter xmlRaw = createExpQuasiQuoter $ \string -> diff --git a/xml-html-qq.cabal b/xml-html-qq.cabal --- a/xml-html-qq.cabal +++ b/xml-html-qq.cabal @@ -1,5 +1,5 @@ name: xml-html-qq -version: 0.1.0.0 +version: 0.1.0.1 synopsis: Quasi-quoters for XML and HTML Documents description: Please see . homepage: https://github.com/cdepillabout/xml-html-qq