Skip to content

Commit

Permalink
Deployed haddocks
Browse files Browse the repository at this point in the history
  • Loading branch information
coot committed Apr 26, 2024
1 parent 83e8377 commit eef26be
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion hedgehog-extras/Hedgehog-Extras-Test-Concurrent.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@
76 ┃ failure
77 ┃ ]
</pre><p>Please note that only <code>FAIL1</code> and <code>FAIL2</code> annotations were reported - <code>FAIL3</code> annotation and the failure
below was swallowed without any information.</p><p><strong>Don't use concurrency abstractions from this module, when you need to aggregate and report failures!</strong></p></div></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:threadDelay">threadDelay</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>, MonadTest m, <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) &#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-Int.html#t:Int" title="Data.Int">Int</a> &#8594; m ()</li><li class="src short"><a href="#v:asyncRegister_">asyncRegister_</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; MonadTest m &#8658; MonadResource m &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/exceptions-0.10.4/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> 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:IO" title="System.IO">IO</a> a &#8594; m ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:threadDelay" class="def">threadDelay</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>, MonadTest m, <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) &#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-Int.html#t:Int" title="Data.Int">Int</a> &#8594; m () <a href="src/Hedgehog.Extras.Test.Concurrent.html#threadDelay" class="link">Source</a> <a href="#v:threadDelay" class="selflink">#</a></p><div class="doc"><p>Delay the thread by <code>n</code> milliseconds.</p></div></div><div class="top"><p class="src"><a id="v:asyncRegister_" class="def">asyncRegister_</a> <a href="src/Hedgehog.Extras.Test.Concurrent.html#asyncRegister_" class="link">Source</a> <a href="#v:asyncRegister_" 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; MonadTest m</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; MonadResource 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/exceptions-0.10.4/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> 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:IO" title="System.IO">IO</a> a</td><td class="doc"><p>Action to run in background</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Runs an action in background, and registers cleanup to `MonadResource m`</p></div></div><a href="#g:1" id="g:1"><h1>Re-exports of concurrency abstractions from <code>lifted-base</code></h1></a><h1>Orphan instances</h1><div id="section.orphans"><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:o:ic:MonadBaseControl:MonadBaseControl:1"></span> MonadBaseControl <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:IO" title="System.IO">IO</a> (ResourceT <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:IO" title="System.IO">IO</a>)</span> <a href="src/Hedgehog.Extras.Test.Concurrent.html#line-116" class="link">Source</a> <a href="#v:-36-fMonadBaseControlIOResourceT" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:o:ic:MonadBaseControl:MonadBaseControl:1"><summary class="hide-when-js-enabled">Instance details</summary><p></p> <div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> StM (ResourceT <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:IO" title="System.IO">IO</a>) a</p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:liftBaseWith">liftBaseWith</a> &#8759; (RunInBase (ResourceT <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:IO" title="System.IO">IO</a>) <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:IO" title="System.IO">IO</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:IO" title="System.IO">IO</a> a) &#8594; ResourceT <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:IO" title="System.IO">IO</a> a</p><p class="src"><a href="#v:restoreM">restoreM</a> &#8759; StM (ResourceT <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:IO" title="System.IO">IO</a>) a &#8594; ResourceT <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:IO" title="System.IO">IO</a> 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:o:ic:MonadBase:MonadBase:2"></span> MonadBase <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:IO" title="System.IO">IO</a> (ResourceT <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:IO" title="System.IO">IO</a>)</span> <a href="src/Hedgehog.Extras.Test.Concurrent.html#line-113" class="link">Source</a> <a href="#v:-36-fMonadBaseIOResourceT" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:o:ic:MonadBase:MonadBase:2"><summary class="hide-when-js-enabled">Instance details</summary><p></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:liftBase">liftBase</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/System-IO.html#t:IO" title="System.IO">IO</a> &#945; &#8594; ResourceT <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:IO" title="System.IO">IO</a> &#945;</p></div></details></td></tr></table></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.26.0</p></div></body></html>
below was swallowed without any information.</p><p><strong>Don't use concurrency abstractions from this module, when you need to aggregate and report failures!</strong></p></div></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:threadDelay">threadDelay</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>, MonadTest m, <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) &#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-Int.html#t:Int" title="Data.Int">Int</a> &#8594; m ()</li><li class="src short"><a href="#v:asyncRegister_">asyncRegister_</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; MonadTest m &#8658; MonadResource m &#8658; <a href="file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/exceptions-0.10.4/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> 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:IO" title="System.IO">IO</a> a &#8594; m ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:threadDelay" class="def">threadDelay</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>, MonadTest m, <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) &#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-Int.html#t:Int" title="Data.Int">Int</a> &#8594; m () <a href="src/Hedgehog.Extras.Test.Concurrent.html#threadDelay" class="link">Source</a> <a href="#v:threadDelay" class="selflink">#</a></p><div class="doc"><p>Delay the thread by <code>n</code> milliseconds.</p></div></div><div class="top"><p class="src"><a id="v:asyncRegister_" class="def">asyncRegister_</a> <a href="src/Hedgehog.Extras.Test.Concurrent.html#asyncRegister_" class="link">Source</a> <a href="#v:asyncRegister_" 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; MonadTest m</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">&#8658; MonadResource 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/exceptions-0.10.4/Control-Monad-Catch.html#t:MonadCatch" title="Control.Monad.Catch">MonadCatch</a> 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:IO" title="System.IO">IO</a> a</td><td class="doc"><p>Action to run in background</p></td></tr><tr><td class="src">&#8594; m ()</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Runs an action in background, and registers its cancellation to <code>MonadResource</code>.</p></div></div><a href="#g:1" id="g:1"><h1>Re-exports of concurrency abstractions from <code>lifted-base</code></h1></a><h1>Orphan instances</h1><div id="section.orphans"><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:o:ic:MonadBaseControl:MonadBaseControl:1"></span> MonadBaseControl <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:IO" title="System.IO">IO</a> (ResourceT <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:IO" title="System.IO">IO</a>)</span> <a href="src/Hedgehog.Extras.Test.Concurrent.html#line-116" class="link">Source</a> <a href="#v:-36-fMonadBaseControlIOResourceT" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:o:ic:MonadBaseControl:MonadBaseControl:1"><summary class="hide-when-js-enabled">Instance details</summary><p></p> <div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> StM (ResourceT <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:IO" title="System.IO">IO</a>) a</p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:liftBaseWith">liftBaseWith</a> &#8759; (RunInBase (ResourceT <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:IO" title="System.IO">IO</a>) <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:IO" title="System.IO">IO</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:IO" title="System.IO">IO</a> a) &#8594; ResourceT <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:IO" title="System.IO">IO</a> a</p><p class="src"><a href="#v:restoreM">restoreM</a> &#8759; StM (ResourceT <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:IO" title="System.IO">IO</a>) a &#8594; ResourceT <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:IO" title="System.IO">IO</a> 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:o:ic:MonadBase:MonadBase:2"></span> MonadBase <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:IO" title="System.IO">IO</a> (ResourceT <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:IO" title="System.IO">IO</a>)</span> <a href="src/Hedgehog.Extras.Test.Concurrent.html#line-113" class="link">Source</a> <a href="#v:-36-fMonadBaseIOResourceT" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:o:ic:MonadBase:MonadBase:2"><summary class="hide-when-js-enabled">Instance details</summary><p></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:liftBase">liftBase</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/System-IO.html#t:IO" title="System.IO">IO</a> &#945; &#8594; ResourceT <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:IO" title="System.IO">IO</a> &#945;</p></div></details></td></tr></table></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.26.0</p></div></body></html>
Binary file modified hedgehog-extras/hedgehog-extras.haddock
Binary file not shown.
2 changes: 1 addition & 1 deletion hedgehog-extras/src/Hedgehog.Extras.Test.Concurrent.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
</span><span class="hs-identifier hs-var">IO.threadDelay</span></span><span> </span><span class="annot"><span class="annottext">Int
</span><a href="#local-6989586621679122873"><span class="hs-identifier hs-var">n</span></a></span><span>
</span><span id="line-100"></span><span>
</span><span id="line-101"></span><span class="hs-comment">-- | Runs an action in background, and registers cleanup to `MonadResource m`</span><span>
</span><span id="line-101"></span><span class="hs-comment">-- | Runs an action in background, and registers its cancellation to 'MonadResource'.</span><span>
</span><span id="line-102"></span><span id="local-6989586621679122930"><span id="local-6989586621679122933"><span class="annot"><a href="Hedgehog.Extras.Test.Concurrent.html#asyncRegister_"><span class="hs-identifier hs-type">asyncRegister_</span></a></span><span> </span><span class="hs-glyph">::</span><span> </span><span class="annot"><a href="../file:///usr/local/.ghcup/ghc/9.2.5/share/doc/ghc-9.2.5/html/libraries/base-4.16.4.0/src"><span class="hs-identifier hs-type">HasCallStack</span></a></span><span>
</span><span id="line-103"></span><span> </span><span class="hs-glyph">=&gt;</span><span> </span><span class="annot"><span class="hs-identifier hs-type">MonadTest</span></span><span> </span><span class="annot"><a href="#local-6989586621679122933"><span class="hs-identifier hs-type">m</span></a></span><span>
</span><span id="line-104"></span><span> </span><span class="hs-glyph">=&gt;</span><span> </span><span class="annot"><span class="hs-identifier hs-type">MonadResource</span></span><span> </span><span class="annot"><a href="#local-6989586621679122933"><span class="hs-identifier hs-type">m</span></a></span><span>
Expand Down

0 comments on commit eef26be

Please sign in to comment.