Skip to content

Commit

Permalink
Language-ext documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@louthy
louthy committed Oct 16, 2024
1 parent efd197f commit 7382129
Show file tree
Hide file tree
Showing 32 changed files with 4,422 additions and 2,263 deletions.
158 changes: 107 additions & 51 deletions language-ext/LanguageExt.Core/Effects/IO/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions language-ext/LanguageExt.Core/Effects/StreamT/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2049,9 +2049,9 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/StreamT/StreamT.Extensions.cs#L32" class="link">Source</a>
<a href="#StreamTExtensions_0_Combine_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Alternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, MonoidK&lt;M&gt;</span></div></div></p>
<div class="doc"><div><p>Execute the stream's inner monad <code>M</code>, combining the results using
its <code>Alternative&lt;M&gt;.Combine</code> operator.</p>
its <code>MonoidK&lt;M&gt;.Combine</code> operator.</p>
</div>
<div></div>
<div class="methods"><p class="caption">Parameters</p>
Expand Down
188 changes: 107 additions & 81 deletions language-ext/LanguageExt.Core/Monads/Alternative Monads/Validation/index.html
View file

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions language-ext/LanguageExt.Core/Monads/Identity/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@
</div></a></li>
<ul><li><a href="#IdentityExt_0_As_1" class="link"><div class="nowrap">As
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>Identity<span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span></div></a></li>
<li><a href="#IdentityExt_0_Run_1" class="link"><div class="nowrap">Run
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>Identity<span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span></div></a></li></ul>
<li><a href="#_0_Identity_0" class="link"><div class="nowrap">Identity
</div></a></li>
Expand Down Expand Up @@ -477,6 +480,31 @@



</div>
<div class="top"><p class="src"><span class="keyword">method</span>
A
<a id="IdentityExt_0_Run_1" class="def">Run</a>
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>Identity<span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Identity/Identity.Extensions.cs#L10" class="link">Source</a>
<a href="#IdentityExt_0_Run_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div></div>


Expand Down
35 changes: 32 additions & 3 deletions language-ext/LanguageExt.Core/Monads/IdentityT/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@
</div></a></li>
<ul><li><a href="#IdentityTExt_0_As_2" class="link"><div class="nowrap">As
<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>IdentityT<span class='generics'>&lt;</span>M<span class='generics'>&gt;</span><span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span></div></a></li>
<li><a href="#IdentityTExt_0_Run_2" class="link"><div class="nowrap">Run
<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>IdentityT<span class='generics'>&lt;</span>M<span class='generics'>&gt;</span><span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span></div></a></li></ul>
<li><a href="#_0_IdentityT_1" class="link"><div class="nowrap">IdentityT
<span class='generics'>&lt;</span>M<span class='generics'>&gt;</span></div></a></li>
Expand All @@ -92,7 +95,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/IdentityT/IdentityT.cs#L11" class="link">Source</a>
<a href="#_0_IdentityT_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div><p>IdentityT monad</p>
</div>
<div></div>
Expand Down Expand Up @@ -615,7 +618,33 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/IdentityT/IdentityT.Extensions.cs#L7" class="link">Source</a>
<a href="#IdentityTExt_0_As_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div>
<div class="top"><p class="src"><span class="keyword">method</span>
K<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<a id="IdentityTExt_0_Run_2" class="def">Run</a>
<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>this K<span class='generics'>&lt;</span>IdentityT<span class='generics'>&lt;</span>M<span class='generics'>&gt;</span><span class='comma'>, </span>A<span class='generics'>&gt;</span> ma<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/IdentityT/IdentityT.Extensions.cs#L11" class="link">Source</a>
<a href="#IdentityTExt_0_Run_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand Down Expand Up @@ -644,7 +673,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/IdentityT/IdentityT.Module.cs#L9" class="link">Source</a>
<a href="#_0_IdentityT_1" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div><p>Identity module</p>
</div>
<div></div>
Expand Down
2 changes: 1 addition & 1 deletion language-ext/LanguageExt.Core/Monads/Monadic conditionals/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h2>When and Unless</h2>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Monadic conditionals/Prelude.guard.cs#L17" class="link">Source</a>
<a href="#Prelude_0_guard_1" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> F : Alternative&lt;F&gt;</span></div></div></p>
<span> F : MonoidK&lt;F&gt;, Applicative&lt;F&gt;</span></div></div></p>
<div class="doc"><div><p>Guard against continuing an applicative expression</p>
</div>
<div></div>
Expand Down
12 changes: 6 additions & 6 deletions language-ext/LanguageExt.Core/Monads/Pure and Fail/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1093,7 +1093,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L141" class="link">Source</a>
<a href="#Pure_1_Bind_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand Down Expand Up @@ -1144,7 +1144,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L148" class="link">Source</a>
<a href="#Pure_1_Bind_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand Down Expand Up @@ -1397,7 +1397,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L186" class="link">Source</a>
<a href="#Pure_1_SelectMany_4" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand All @@ -1423,7 +1423,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L190" class="link">Source</a>
<a href="#Pure_1_SelectMany_4" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand Down Expand Up @@ -1499,7 +1499,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L200" class="link">Source</a>
<a href="#Pure_1_SelectMany_4" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand All @@ -1525,7 +1525,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Pure and Fail/Pure.cs#L204" class="link">Source</a>
<a href="#Pure_1_SelectMany_4" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, SemiAlternative&lt;M&gt;</span></div></div></p>
<span> M : Monad&lt;M&gt;, SemigroupK&lt;M&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand Down
Loading

0 comments on commit 7382129

Please sign in to comment.