Skip to content

Commit

Permalink
Language-ext documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
louthy committed Oct 27, 2024
1 parent a56fd84 commit fa0061d
Show file tree
Hide file tree
Showing 6 changed files with 563 additions and 214 deletions.

Large diffs are not rendered by default.

270 changes: 189 additions & 81 deletions language-ext/LanguageExt.Core/Monads/Alternative Monads/Fin/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
<li><a href="#Try_1_Map_1" class="link"><div class="nowrap">Map
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span> f<span class='parens'>)</span></div></a></li>
<li><a href="#Try_1_MapFail_0" class="link"><div class="nowrap">MapFail

<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Error<span class='comma'>, </span>Error<span class='generics'>&gt;</span> f<span class='parens'>)</span></div></a></li>
<li><a href="#Try_1_Select_1" class="link"><div class="nowrap">Select
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span> f<span class='parens'>)</span></div></a></li>
Expand Down Expand Up @@ -587,13 +590,46 @@



</div>
<div class="top"><p class="src"><span class="keyword">method</span>
Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<a id="Try_1_MapFail_0" class="def">MapFail</a>

<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Error<span class='comma'>, </span>Error<span class='generics'>&gt;</span> f<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L145" class="link">Source</a>
<a href="#Try_1_MapFail_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Maps the bound value</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">param</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">f</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Mapping function</p>
</span></td></tr>
<tr><td class="src clearfix"><span class="keyword">returns</span></td>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p><code>TryT</code></p>
</span></td></tr></tbody></table></div></div>
</div>












</div>
<div class="top"><p class="src"><span class="keyword">method</span>
Try<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<a id="Try_1_Select_1" class="def">Select</a>
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='generics'>&gt;</span> f<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L146" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L154" class="link">Source</a>
<a href="#Try_1_Select_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Maps the bound value</p>
Expand Down Expand Up @@ -630,7 +666,7 @@
<a id="Try_1_Bind_1" class="def">Bind</a>
<span class='generics'>&lt;</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>Try<span class='comma'>, </span>B<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/Monads/Alternative Monads/Try/Try.cs#L160" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L168" class="link">Source</a>
<a href="#Try_1_Bind_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -667,7 +703,7 @@
<a id="Try_1_Bind_1" class="def">Bind</a>
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Try<span class='generics'>&lt;</span>B<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/Monads/Alternative Monads/Try/Try.cs#L175" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L183" class="link">Source</a>
<a href="#Try_1_Bind_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -704,7 +740,7 @@
<a id="Try_1_Bind_1" class="def">Bind</a>
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Pure<span class='generics'>&lt;</span>B<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/Monads/Alternative Monads/Try/Try.cs#L190" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L198" class="link">Source</a>
<a href="#Try_1_Bind_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -741,7 +777,7 @@
<a id="Try_1_BiBind_1" class="def">BiBind</a>
<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Try<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> Succ<span class='comma'>, </span>Func<span class='generics'>&lt;</span>Error<span class='comma'>, </span>Try<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> Fail<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L199" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L207" class="link">Source</a>
<a href="#Try_1_BiBind_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -778,7 +814,7 @@
<a id="Try_1_BindFail_0" class="def">BindFail</a>

<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Error<span class='comma'>, </span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span><span class='generics'>&gt;</span> Fail<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L214" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L222" class="link">Source</a>
<a href="#Try_1_BindFail_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -815,7 +851,7 @@
<a id="Try_1_SelectMany_2" class="def">SelectMany</a>
<span class='generics'>&lt;</span>B<span class='comma'>, </span>C<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>Try<span class='comma'>, </span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> bind<span class='comma'>, </span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span> project<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L230" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L238" class="link">Source</a>
<a href="#Try_1_SelectMany_2" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -860,7 +896,7 @@
<a id="Try_1_SelectMany_2" class="def">SelectMany</a>
<span class='generics'>&lt;</span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Try<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> bind<span class='comma'>, </span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span> project<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L241" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L249" class="link">Source</a>
<a href="#Try_1_SelectMany_2" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -905,7 +941,7 @@
<a id="Try_1_SelectMany_2" class="def">SelectMany</a>
<span class='generics'>&lt;</span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Fin<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> bind<span class='comma'>, </span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span> project<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L252" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L260" class="link">Source</a>
<a href="#Try_1_SelectMany_2" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -950,7 +986,7 @@
<a id="Try_1_SelectMany_2" class="def">SelectMany</a>
<span class='generics'>&lt;</span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>Pure<span class='generics'>&lt;</span>B<span class='generics'>&gt;</span><span class='generics'>&gt;</span> bind<span class='comma'>, </span>Func<span class='generics'>&lt;</span>A<span class='comma'>, </span>B<span class='comma'>, </span>C<span class='generics'>&gt;</span> project<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L263" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L271" class="link">Source</a>
<a href="#Try_1_SelectMany_2" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Monad bind operation</p>
Expand Down Expand Up @@ -995,7 +1031,7 @@
<a id="Try_1_Combine_0" class="def">Combine</a>

<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> rhs<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L312" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L320" class="link">Source</a>
<a href="#Try_1_Combine_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1019,7 +1055,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> lhs<span class='comma'>, </span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> rhs<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L288" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L296" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1042,7 +1078,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> lhs<span class='comma'>, </span>K<span class='generics'>&lt;</span>Try<span class='comma'>, </span>A<span class='generics'>&gt;</span> rhs<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L291" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L299" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1065,7 +1101,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>K<span class='generics'>&lt;</span>Try<span class='comma'>, </span>A<span class='generics'>&gt;</span> lhs<span class='comma'>, </span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> rhs<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L294" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L302" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1088,7 +1124,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<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/Monads/Alternative Monads/Try/Try.cs#L297" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L305" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1111,7 +1147,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<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> mb<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L300" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L308" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1134,7 +1170,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Fail<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/Monads/Alternative Monads/Try/Try.cs#L303" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L311" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1157,7 +1193,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>Exception mb<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L306" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L314" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1180,7 +1216,7 @@
<div class="top"><p class="src"><span class="keyword">operator</span>
<a id="Try_1_|_0" class="def">|</a>
<span class='parens'>(</span>Try<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> ma<span class='comma'>, </span>CatchM<span class='generics'>&lt;</span>Error<span class='comma'>, </span>Try<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/Monads/Alternative Monads/Try/Try.cs#L309" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/Alternative Monads/Try/Try.cs#L317" class="link">Source</a>
<a href="#Try_1_|_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down
Loading

0 comments on commit fa0061d

Please sign in to comment.