Language-ext documentation update

louthy · Aug 4, 2024 · 7453b30 · 7453b30
1 parent 8bfeb47
commit 7453b30
Show file tree

Hide file tree

Showing 34 changed files with 4,669 additions and 1,628 deletions.
diff --git a/language-ext/LanguageExt.Core/Concurrency/Atom/index.html b/language-ext/LanguageExt.Core/Concurrency/Atom/index.html
diff --git a/language-ext/LanguageExt.Core/Concurrency/index.html b/language-ext/LanguageExt.Core/Concurrency/index.html
diff --git a/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/Extensions/index.html b/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/Extensions/index.html
diff --git a/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/Prelude/index.html b/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/Prelude/index.html
@@ -153,9 +153,7 @@
 <li><a href="#Prelude_0_localCancel_1" class="link"><div class="nowrap">localCancel
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span></div></a></li>
-<li><a href="#Prelude_0_cancelTokenEff_0" class="link"><div class="nowrap">cancelTokenEff
-
-<span class='parens'>(</span><span class='parens'>)</span></div></a></li>
+<li><a href="#Prelude_0_cancelTokenEff_0" class="link"><div class="nowrap">cancelTokenEff</div></a></li>
 <li><a href="#Prelude_0_flatten_1" class="link"><div class="nowrap">flatten
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> mma<span class='parens'>)</span></div></a></li>
@@ -982,8 +980,35 @@
 
 </div></div>
 
+<div class="subs methods"><p class="caption">Properties</p>
+<div class="top"><p class="src"><span class="keyword">property</span>
+Eff<span class='generics'>&lt;</span>CancellationToken<span class='generics'>&gt;</span>
+<a id="Prelude_0_cancelTokenEff_0" class="def">cancelTokenEff</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Prelude/Eff.Prelude.cs#L71" class="link">Source</a>
+<a href="#Prelude_0_cancelTokenEff_0" class="selflink">#</a>
+<div class="constraints"></div></p>
+<div class="doc"><div><p>Cancellation token</p>
+</div>
+<div></div>
+<div class="methods"><p class="caption">Parameters</p>
+<div class="params-and-returns"><table><tbody><tr><td class="src clearfix"><span class="keyword">returns</span></td>
+<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>CancellationToken</p>
+</span></td></tr></tbody></table></div></div>
+</div>
 
 
+
+
+
+
+
+
+
+
+
+
+</div></div>
+
 <div class="subs methods"><p class="caption">Methods</p>
 <div class="top"><p class="src"><span class="keyword">method</span>
 Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
@@ -1121,35 +1146,6 @@
 
 
 
-</div>
-<div class="top"><p class="src"><span class="keyword">method</span>
-Eff<span class='generics'>&lt;</span>CancellationToken<span class='generics'>&gt;</span>
-<a id="Prelude_0_cancelTokenEff_0" class="def">cancelTokenEff</a>
-
-<span class='parens'>(</span><span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Prelude/Eff.Prelude.cs#L71" class="link">Source</a>
-<a href="#Prelude_0_cancelTokenEff_0" class="selflink">#</a>
-<div class="constraints"></div></p>
-<div class="doc"><div><p>Cancellation token</p>
-</div>
-<div></div>
-<div class="methods"><p class="caption">Parameters</p>
-<div class="params-and-returns"><table><tbody><tr><td class="src clearfix"><span class="keyword">returns</span></td>
-<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>CancellationToken</p>
-</span></td></tr></tbody></table></div></div>
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>

diff --git a/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/index.html b/language-ext/LanguageExt.Core/Effects/Eff/Eff no runtime/index.html
diff --git a/language-ext/LanguageExt.Core/Effects/Eff/Eff with runtime/Extensions/index.html b/language-ext/LanguageExt.Core/Effects/Eff/Eff with runtime/Extensions/index.html
diff --git a/language-ext/LanguageExt.Core/Effects/Eff/Eff with runtime/index.html b/language-ext/LanguageExt.Core/Effects/Eff/Eff with runtime/index.html
diff --git a/language-ext/LanguageExt.Core/Effects/IO/index.html b/language-ext/LanguageExt.Core/Effects/IO/index.html
@@ -41,10 +41,10 @@
 <li><a href="#_0_IO_1" class="link"><div class="nowrap">IO
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>Func<span class='generics'>&lt;</span>EnvIO<span class='comma'>, </span>A<span class='generics'>&gt;</span> runIO<span class='parens'>)</span></div></a></li>
-<ul><li><a href="#IO_1_Pure_0" class="link"><div class="nowrap">Pure
+<ul><li><a href="#IO_1_pure_0" class="link"><div class="nowrap">pure
 
 <span class='parens'>(</span>A value<span class='parens'>)</span></div></a></li>
-<li><a href="#IO_1_Fail_0" class="link"><div class="nowrap">Fail
+<li><a href="#IO_1_fail_0" class="link"><div class="nowrap">fail
 
 <span class='parens'>(</span>Error value<span class='parens'>)</span></div></a></li>
 <li><a href="#IO_1_Empty =
@@ -356,7 +356,7 @@
 <span class='parens'>(</span>this IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> fa<span class='comma'>, </span>IO<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span> fb<span class='parens'>)</span></div></a></li></ul>
 <li><a href="#_0_IO_0" class="link"><div class="nowrap">IO
 </div></a></li>
-<ul><li><a href="#IO_0_Fail_1" class="link"><div class="nowrap">Fail
+<ul><li><a href="#IO_0_fail_1" class="link"><div class="nowrap">fail
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>Error value<span class='parens'>)</span></div></a></li>
 <li><a href="#IO_0_lift_0" class="link"><div class="nowrap">lift
@@ -436,7 +436,7 @@
 <span class='parens'>(</span>double milliseconds<span class='parens'>)</span></div></a></li></ul>
 <li><a href="#_0_IO_0" class="link"><div class="nowrap">IO
 </div></a></li>
-<ul><li><a href="#IO_0_Pure_1" class="link"><div class="nowrap">Pure
+<ul><li><a href="#IO_0_pure_1" class="link"><div class="nowrap">pure
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>A value<span class='parens'>)</span></div></a></li></ul>
 <li><a href="#_0_Prelude_0" class="link"><div class="nowrap">Prelude
@@ -456,8 +456,8 @@
                  throw new TaskCanceledException();
              })</div></a></li>
 <li><a href="#Prelude_0_unitIO = 
-        IO<Unit>.Pure(default)_0" class="link"><div class="nowrap">unitIO = 
-        IO&lt;Unit&gt;.Pure(default)</div></a></li>
+        IO<Unit>.pure(default)_0" class="link"><div class="nowrap">unitIO = 
+        IO&lt;Unit&gt;.pure(default)</div></a></li>
 <li><a href="#Prelude_0_envIO = 
         IO<EnvIO>.Lift(e => e)_0" class="link"><div class="nowrap">envIO = 
         IO&lt;EnvIO&gt;.Lift(e =&gt; e)</div></a></li>
@@ -928,11 +928,11 @@
 <div class="subs methods"><p class="caption">Methods</p>
 <div class="top"><p class="src"><span class="keyword">method</span>
 IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
-<a id="IO_1_Pure_0" class="def">Pure</a>
+<a id="IO_1_pure_0" class="def">pure</a>
 
 <span class='parens'>(</span>A value<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.cs#L36" class="link">Source</a>
-<a href="#IO_1_Pure_0" class="selflink">#</a>
+<a href="#IO_1_pure_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>
 <div></div>
@@ -953,11 +953,11 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
-<a id="IO_1_Fail_0" class="def">Fail</a>
+<a id="IO_1_fail_0" class="def">fail</a>
 
 <span class='parens'>(</span>Error value<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.cs#L39" class="link">Source</a>
-<a href="#IO_1_Fail_0" class="selflink">#</a>
+<a href="#IO_1_fail_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>
 <div></div>
@@ -3524,11 +3524,11 @@
 <div class="subs methods"><p class="caption">Methods</p>
 <div class="top"><p class="src"><span class="keyword">method</span>
 IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
-<a id="IO_0_Fail_1" class="def">Fail</a>
+<a id="IO_0_fail_1" class="def">fail</a>
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>Error value<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Module.cs#L20" class="link">Source</a>
-<a href="#IO_0_Fail_1" class="selflink">#</a>
+<a href="#IO_0_fail_1" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Put the IO into a failure state</p>
 </div>
@@ -4130,7 +4130,7 @@
 <div class="top"><p class="src"><span class="keyword">class</span>
 <a id="_0_IO_0" class="def">IO</a>
 
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Monad.cs#L9" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Monad.cs#L8" class="link">Source</a>
 <a href="#_0_IO_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>
@@ -4147,11 +4147,11 @@
 <div class="subs methods"><p class="caption">Methods</p>
 <div class="top"><p class="src"><span class="keyword">method</span>
 IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
-<a id="IO_0_Pure_1" class="def">Pure</a>
+<a id="IO_0_pure_1" class="def">pure</a>
 <span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>A value<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Monad.cs#L11" class="link">Source</a>
-<a href="#IO_0_Pure_1" class="selflink">#</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Monad.cs#L13" class="link">Source</a>
+<a href="#IO_0_pure_1" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>
 <div></div>
@@ -4261,11 +4261,11 @@
 <div class="top"><p class="src"><span class="keyword">field</span>
 IO<span class='generics'>&lt;</span>Unit<span class='generics'>&gt;</span>
 <a id="Prelude_0_unitIO = 
-        IO<Unit>.Pure(default)_0" class="def">unitIO = 
-        IO&lt;Unit&gt;.Pure(default)</a>
+        IO<Unit>.pure(default)_0" class="def">unitIO = 
+        IO&lt;Unit&gt;.pure(default)</a>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.Prelude.cs#L33" class="link">Source</a>
 <a href="#Prelude_0_unitIO = 
-        IO<Unit>.Pure(default)_0" class="selflink">#</a>
+        IO<Unit>.pure(default)_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Always yields a <code>Unit</code> value</p>
 </div>