Skip to content

Commit

Permalink
Deployed haddocks
Browse files Browse the repository at this point in the history
  • Loading branch information
@coot
coot committed Jun 7, 2023
1 parent e2bc90b commit 2ce598c
Show file tree
Hide file tree
Showing 22 changed files with 1,601 additions and 1,627 deletions.
8 changes: 4 additions & 4 deletions hedgehog-extras/Hedgehog-Extras-Test-Golden.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!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" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Hedgehog.Extras.Test.Golden</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">hedgehog-extras-0.4.5.1: Supplemental library for hedgehog</span><ul class="links" id="page-menu"><li><a href="src/Hedgehog.Extras.Test.Golden.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Hedgehog.Extras.Test.Golden</p></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:diffVsGoldenFile">diffVsGoldenFile</a> &#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a> &#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m) &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Data-String.html#t:String" title="Data.String">String</a> &#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; m ()</li><li class="src short"><a href="#v:diffFileVsGoldenFile">diffFileVsGoldenFile</a> &#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a> &#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m) &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; m ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:diffVsGoldenFile" class="def">diffVsGoldenFile</a> <a href="src/Hedgehog.Extras.Test.Golden.html#diffVsGoldenFile" class="link">Source</a> <a href="#v:diffVsGoldenFile" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">&#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Data-String.html#t:String" title="Data.String">String</a></td><td class="doc"><p>Actual content</p></td></tr><tr><td class="src">&#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Reference file</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Diff contents against the golden file. If CREATE_GOLDEN_FILES environment is
set to &quot;1&quot;, then should the gold file not exist it would be created. If
RECREATE_GOLDEN_FILES is set to &quot;1&quot;, the golden files will be overwritten. If
<!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" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Hedgehog.Extras.Test.Golden</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">hedgehog-extras-0.4.5.1: Supplemental library for hedgehog</span><ul class="links" id="page-menu"><li><a href="src/Hedgehog.Extras.Test.Golden.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Hedgehog.Extras.Test.Golden</p></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:diffVsGoldenFile">diffVsGoldenFile</a> &#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a> &#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m) &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Data-String.html#t:String" title="Data.String">String</a> &#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; m ()</li><li class="src short"><a href="#v:diffFileVsGoldenFile">diffFileVsGoldenFile</a> &#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a> &#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m) &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a> &#8594; m ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:diffVsGoldenFile" class="def">diffVsGoldenFile</a> <a href="src/Hedgehog.Extras.Test.Golden.html#diffVsGoldenFile" class="link">Source</a> <a href="#v:diffVsGoldenFile" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">&#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Data-String.html#t:String" title="Data.String">String</a></td><td class="doc"><p>Actual content</p></td></tr><tr><td class="src">&#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Reference file</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Diff contents against the golden file. If CREATE_GOLDEN_FILES environment is
set to &quot;1&quot;, then should the gold file not exist it would be created. If
GOLDEN_FILE_LOG_FILE is set to a filename, then the golden file path will be
logged to the specified file.</p><p>Set the environment variable when you intend to generate or re-generate the golden
file for example when running the test for the first time or if the golden file
genuinely needs to change.</p><p>To re-generate a golden file you must also delete the golden file because golden
files are never overwritten.</p><p>TODO: Improve the help output by saying the difference of each input.</p></div></div><div class="top"><p class="src"><a id="v:diffFileVsGoldenFile" class="def">diffFileVsGoldenFile</a> <a href="src/Hedgehog.Extras.Test.Golden.html#diffFileVsGoldenFile" class="link">Source</a> <a href="#v:diffFileVsGoldenFile" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">&#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Actual file</p></td></tr><tr><td class="src">&#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Reference file</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Diff file against the golden file. If CREATE_GOLDEN_FILES environment is
files are never overwritten.</p><p>TODO: Improve the help output by saying the difference of
each input.</p></div></div><div class="top"><p class="src"><a id="v:diffFileVsGoldenFile" class="def">diffFileVsGoldenFile</a> <a href="src/Hedgehog.Extras.Test.Golden.html#diffFileVsGoldenFile" class="link">Source</a> <a href="#v:diffFileVsGoldenFile" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">&#8759; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/GHC-Stack.html#t:HasCallStack" title="GHC.Stack">HasCallStack</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; (<a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m, MonadTest m)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Actual file</p></td></tr><tr><td class="src">&#8594; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/System-IO.html#t:FilePath" title="System.IO">FilePath</a></td><td class="doc"><p>Reference file</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Diff file against the golden file. If CREATE_GOLDEN_FILES environment is
set to &quot;1&quot;, then should the gold file not exist it would be created. If
GOLDEN_FILE_LOG_FILE is set to a filename, then the golden file path will be
logged to the specified file.</p><p>Set the environment variable when you intend to generate or re-generate the golden
Expand Down
Binary file modified hedgehog-extras/hedgehog-extras.haddock
View file
Binary file not shown.

0 comments on commit 2ce598c

Please sign in to comment.