Language-ext documentation update

louthy · May 12, 2024 · 849326b · 849326b
1 parent 0e6de22
commit 849326b
Show file tree

Hide file tree

Showing 12 changed files with 895 additions and 372 deletions.
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
@@ -2510,7 +2510,7 @@
 <a id="Eff_1_ToString_0" class="def">ToString</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/Eff.cs#L957" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L958" class="link">Source</a>
 <a href="#Eff_1_ToString_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>
@@ -2535,7 +2535,7 @@
 <a id="Eff_1_Success_0" class="def">Success</a>
 
 <span class='parens'>(</span>A value<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1086" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1090" class="link">Source</a>
 <a href="#Eff_1_Success_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Lift a value into the <code>Eff</code> monad</p>
@@ -2561,7 +2561,7 @@
 <a id="Eff_1_Effect_0" class="def">Effect</a>
 
 <span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> f<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1094" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1098" class="link">Source</a>
 <a href="#Eff_1_Effect_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Lift a synchronous effect into the <code>Eff</code> monad</p>
@@ -2587,7 +2587,7 @@
 <a id="Eff_1_EffectMaybe_0" class="def">EffectMaybe</a>
 
 <span class='parens'>(</span>Func<span class='generics'>&lt;</span>Fin<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1102" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L1106" class="link">Source</a>
 <a href="#Eff_1_EffectMaybe_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Lift a synchronous effect into the <code>Eff</code> monad</p>
@@ -2612,7 +2612,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L825" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L826" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2648,7 +2648,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Pure<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L836" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L837" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2684,7 +2684,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Fail<span class='generics'>&lt;</span>Error<span class='generics'>&gt;</span> error<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L847" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L848" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2720,7 +2720,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Error error<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L858" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L859" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2756,7 +2756,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>A value<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L869" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L870" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2792,7 +2792,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchError<span class='generics'>&lt;</span>Error<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L880" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L881" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2828,7 +2828,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchError mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L891" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L892" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2864,7 +2864,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchError<span class='generics'>&lt;</span>Exception<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L902" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L903" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2900,7 +2900,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchValue<span class='generics'>&lt;</span>Error<span class='comma'>, </span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L913" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L914" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2936,7 +2936,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchValue<span class='generics'>&lt;</span>Exception<span class='comma'>, </span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L924" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L925" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -2972,7 +2972,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchValue<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L935" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L936" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the
@@ -3008,7 +3008,7 @@
 <div class="top"><p class="src"><span class="keyword">operator</span>
 <a id="Eff_1_|_0" class="def">|</a>
 <span class='parens'>(</span>Eff<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchM<span class='generics'>&lt;</span>Eff<span class='comma'>, </span>A<span class='generics'>&gt;</span> mb<span class='parens'>)</span>
-<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L946" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/Eff/Eff no runtime/Eff.cs#L947" class="link">Source</a>
 <a href="#Eff_1_|_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div><p>Run the first IO operation; if it fails, run the second.  Otherwise return the