Language-ext documentation update

louthy · Apr 16, 2024 · 0e6de22 · 0e6de22
1 parent b0bc433
commit 0e6de22
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 31 deletions.
diff --git a/language-ext/LanguageExt.Core/Effects/IO/index.html b/language-ext/LanguageExt.Core/Effects/IO/index.html
@@ -2499,7 +2499,7 @@
 <a id="IO_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/IO/IO.cs#L858" class="link">Source</a>
+<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/IO.cs#L884" class="link">Source</a>
 <a href="#IO_1_ToString_0" class="selflink">#</a>
 <div class="constraints"></div></p>
 <div class="doc"><div></div>

diff --git a/language-ext/LanguageExt.Core/Traits/Traversable/index.html b/language-ext/LanguageExt.Core/Traits/Traversable/index.html
@@ -25,16 +25,16 @@
 <span class='parens'>(</span>
         this K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta,
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f<span class='parens'>)</span></div></a></li>
-<li><a href="#TraversableExtensions_0_SequenceA_3" class="link"><div class="nowrap">SequenceA
+<li><a href="#TraversableExtensions_0_Sequence_3" class="link"><div class="nowrap">Sequence
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#TraversableExtensions_0_MapM_4" class="link"><div class="nowrap">MapM
+<li><a href="#TraversableExtensions_0_TraverseM_4" class="link"><div class="nowrap">TraverseM
 <span class='generics'>&lt;</span>M<span class='comma'>, </span>T<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#TraversableExtensions_0_Sequence_3" class="link"><div class="nowrap">Sequence
+<li><a href="#TraversableExtensions_0_SequenceM_3" class="link"><div class="nowrap">SequenceM
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li></ul>
@@ -45,16 +45,16 @@
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_0_sequenceA_3" class="link"><div class="nowrap">sequenceA
+<li><a href="#Traversable_0_sequence_3" class="link"><div class="nowrap">sequence
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_0_mapM_4" class="link"><div class="nowrap">mapM
+<li><a href="#Traversable_0_traverseM_4" class="link"><div class="nowrap">traverseM
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_0_sequence_3" class="link"><div class="nowrap">sequence
+<li><a href="#Traversable_0_sequenceM_3" class="link"><div class="nowrap">sequenceM
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li></ul>
@@ -65,16 +65,16 @@
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_1_SequenceA_2" class="link"><div class="nowrap">SequenceA
+<li><a href="#Traversable_1_Sequence_2" class="link"><div class="nowrap">Sequence
 <span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_1_MapM_3" class="link"><div class="nowrap">MapM
+<li><a href="#Traversable_1_TraverseM_3" class="link"><div class="nowrap">TraverseM
 <span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
-<li><a href="#Traversable_1_Sequence_2" class="link"><div class="nowrap">Sequence
+<li><a href="#Traversable_1_SequenceM_2" class="link"><div class="nowrap">SequenceM
 <span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span></div></a></li>
@@ -143,12 +143,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>F<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="TraversableExtensions_0_SequenceA_3" class="def">SequenceA</a>
+<a id="TraversableExtensions_0_Sequence_3" class="def">Sequence</a>
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Extensions.cs#L24" class="link">Source</a>
-<a href="#TraversableExtensions_0_SequenceA_3" class="selflink">#</a>
+<a href="#TraversableExtensions_0_Sequence_3" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -173,13 +173,13 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>M<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="TraversableExtensions_0_MapM_4" class="def">MapM</a>
+<a id="TraversableExtensions_0_TraverseM_4" class="def">TraverseM</a>
 <span class='generics'>&lt;</span>M<span class='comma'>, </span>T<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Extensions.cs#L30" class="link">Source</a>
-<a href="#TraversableExtensions_0_MapM_4" class="selflink">#</a>
+<a href="#TraversableExtensions_0_TraverseM_4" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -204,12 +204,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>F<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="TraversableExtensions_0_Sequence_3" class="def">Sequence</a>
+<a id="TraversableExtensions_0_SequenceM_3" class="def">SequenceM</a>
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         this K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Extensions.cs#L37" class="link">Source</a>
-<a href="#TraversableExtensions_0_Sequence_3" class="selflink">#</a>
+<a href="#TraversableExtensions_0_SequenceM_3" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -319,12 +319,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>F<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_0_sequenceA_3" class="def">sequenceA</a>
+<a id="Traversable_0_sequence_3" class="def">sequence</a>
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Module.cs#L39" class="link">Source</a>
-<a href="#Traversable_0_sequenceA_3" class="selflink">#</a>
+<a href="#Traversable_0_sequence_3" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -368,13 +368,13 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>M<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_0_mapM_4" class="def">mapM</a>
+<a id="Traversable_0_traverseM_4" class="def">traverseM</a>
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Module.cs#L56" class="link">Source</a>
-<a href="#Traversable_0_mapM_4" class="selflink">#</a>
+<a href="#Traversable_0_traverseM_4" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -426,12 +426,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>M<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_0_sequence_3" class="def">sequence</a>
+<a id="Traversable_0_sequenceM_3" class="def">sequenceM</a>
 <span class='generics'>&lt;</span>T<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Module.cs#L71" class="link">Source</a>
-<a href="#Traversable_0_sequence_3" class="selflink">#</a>
+<a href="#Traversable_0_sequenceM_3" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> T : Traversable&lt;T&gt;
         </span></div>
@@ -535,12 +535,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>F<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_1_SequenceA_2" class="def">SequenceA</a>
+<a id="Traversable_1_Sequence_2" class="def">Sequence</a>
 <span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Trait.cs#L22" class="link">Source</a>
-<a href="#Traversable_1_SequenceA_2" class="selflink">#</a>
+<a href="#Traversable_1_Sequence_2" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> F : Applicative&lt;F&gt;</span></div></div></p>
 <div class="doc"><div></div>
@@ -562,13 +562,13 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>M<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_1_MapM_3" class="def">MapM</a>
+<a id="Traversable_1_TraverseM_3" class="def">TraverseM</a>
 <span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>K<span class='generics'>&lt;</span>M<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> f,
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Trait.cs#L27" class="link">Source</a>
-<a href="#Traversable_1_MapM_3" class="selflink">#</a>
+<a href="#Traversable_1_TraverseM_3" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> M : Monad&lt;M&gt;</span></div></div></p>
 <div class="doc"><div></div>
@@ -590,12 +590,12 @@
 </div>
 <div class="top"><p class="src"><span class="keyword">method</span>
 K<span class='generics'>&lt;</span>F<span class='comma'>, </span>K<span class='generics'>&lt;</span>T<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span>
-<a id="Traversable_1_Sequence_2" class="def">Sequence</a>
+<a id="Traversable_1_SequenceM_2" class="def">SequenceM</a>
 <span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span>
 <span class='parens'>(</span>
         K<span class='generics'>&lt;</span>T<span class='comma'>, </span>K<span class='generics'>&lt;</span>F<span class='comma'>, </span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> ta<span class='parens'>)</span>
 <a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Traits/Traversable/Traversable.Trait.cs#L33" class="link">Source</a>
-<a href="#Traversable_1_Sequence_2" class="selflink">#</a>
+<a href="#Traversable_1_SequenceM_2" class="selflink">#</a>
 <div class="constraints"><div class="constraint"><span class="keyword">where</span>
 <span> F : Monad&lt;F&gt;</span></div></div></p>
 <div class="doc"><div></div>