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 Nov 27, 2024
1 parent 0994242 commit 854de28
Show file tree
Hide file tree
Showing 10 changed files with 508 additions and 533 deletions.
230 changes: 115 additions & 115 deletions language-ext/LanguageExt.Core/DataTypes/BigInt/index.html

Large diffs are not rendered by default.

420 changes: 238 additions & 182 deletions language-ext/LanguageExt.Core/Immutable Collections/Map/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 @@ -3426,7 +3426,7 @@
<div class="top"><p class="src"><span class="keyword">class</span>
<a id="SetModule_0_SetEnumerator_1" class="def">SetEnumerator</a>
<span class='generics'>&lt;</span>K<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1410" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1404" class="link">Source</a>
<a href="#SetModule_0_SetEnumerator_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -3442,7 +3442,7 @@
<div class="top"><p class="src"><span class="keyword">property</span>
K
<a id="SetEnumerator_1_Current_0" class="def">Current</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1441" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1435" class="link">Source</a>
<a href="#SetEnumerator_1_Current_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -3466,7 +3466,7 @@
<div class="top"><p class="src"><span class="keyword">constructor</span>
<a id="SetEnumerator_1_SetEnumerator_0" class="def">SetEnumerator</a>
<span class='parens'>(</span>SetItem<span class='generics'>&lt;</span>K<span class='generics'>&gt;</span> root<span class='comma'>, </span>bool rev<span class='comma'>, </span>int start<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1425" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1419" class="link">Source</a>
<a href="#SetEnumerator_1_SetEnumerator_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -3492,7 +3492,7 @@
<a id="SetEnumerator_1_Dispose_0" class="def">Dispose</a>

<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1444" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1438" class="link">Source</a>
<a href="#SetEnumerator_1_Dispose_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -3517,7 +3517,7 @@
<a id="SetEnumerator_1_MoveNext_0" class="def">MoveNext</a>

<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1469" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1463" class="link">Source</a>
<a href="#SetEnumerator_1_MoveNext_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -3542,7 +3542,7 @@
<a id="SetEnumerator_1_Reset_0" class="def">Reset</a>

<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1484" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Immutable Collections/Set/Set.Internal.cs#L1478" class="link">Source</a>
<a href="#SetEnumerator_1_Reset_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2076,21 +2076,12 @@
<div class="top"><p class="src"><span class="keyword">class</span>
<a id="_0_ReaderT_2" class="def">ReaderT</a>
<span class='generics'>&lt;</span>Env<span class='comma'>, </span>M<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L24" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L19" class="link">Source</a>
<a href="#_0_ReaderT_2" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p><code>MonadReaderT</code> trait implementation for <code>ReaderT</code></p>
</div>
<div class="doc"><div></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">type</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">Env</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Reader environment type</p>
</span></td></tr>
<tr><td class="src clearfix"><span class="keyword">type</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">M</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Given monad trait</p>
</span></td></tr></tbody></table></div></div>

</div>


Expand All @@ -2105,7 +2096,7 @@
<a id="ReaderT_2_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/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L26" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L21" class="link">Source</a>
<a href="#ReaderT_2_pure_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -2130,7 +2121,7 @@
<a id="ReaderT_2_liftIO_1" class="def">liftIO</a>
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> effect<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L34" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L29" class="link">Source</a>
<a href="#ReaderT_2_liftIO_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Lifts a given monad into the transformer</p>
Expand Down Expand Up @@ -2166,7 +2157,7 @@
<div class="top"><p class="src"><span class="keyword">class</span>
<a id="_0_ReaderT_0" class="def">ReaderT</a>

<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L43" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L38" class="link">Source</a>
<a href="#_0_ReaderT_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p><code>MonadReaderT</code> trait implementation for <code>ReaderT</code></p>
Expand Down Expand Up @@ -2195,7 +2186,7 @@
<a id="ReaderT_0_pure_3" class="def">pure</a>
<span class='generics'>&lt;</span>Env<span class='comma'>, </span>M<span class='comma'>, </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/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L45" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L40" class="link">Source</a>
<a href="#ReaderT_0_pure_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2221,7 +2212,7 @@
<a id="ReaderT_0_lift_3" class="def">lift</a>
<span class='generics'>&lt;</span>Env<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>M<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/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L49" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L44" class="link">Source</a>
<a href="#ReaderT_0_lift_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2247,7 +2238,7 @@
<a id="ReaderT_0_liftIO_3" class="def">liftIO</a>
<span class='generics'>&lt;</span>Env<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>IO<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span> effect<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L58" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L53" class="link">Source</a>
<a href="#ReaderT_0_liftIO_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand Down Expand Up @@ -2281,7 +2272,7 @@
<a id="ReaderT_0_ask_2" class="def">ask</a>
<span class='generics'>&lt;</span>M<span class='comma'>, </span>Env<span class='generics'>&gt;</span>
<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L62" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L57" class="link">Source</a>
<a href="#ReaderT_0_ask_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2307,7 +2298,7 @@
<a id="ReaderT_0_asks_3" class="def">asks</a>
<span class='generics'>&lt;</span>M<span class='comma'>, </span>A<span class='comma'>, </span>Env<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Env<span class='comma'>, </span>A<span class='generics'>&gt;</span> f<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L66" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L61" class="link">Source</a>
<a href="#ReaderT_0_asks_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2333,7 +2324,7 @@
<a id="ReaderT_0_asksM_3" class="def">asksM</a>
<span class='generics'>&lt;</span>M<span class='comma'>, </span>Env<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Env<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> f<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L70" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L65" class="link">Source</a>
<a href="#ReaderT_0_asksM_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2359,7 +2350,7 @@
<a id="ReaderT_0_local_3" class="def">local</a>
<span class='generics'>&lt;</span>Env<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Env<span class='comma'>, </span>Env<span class='generics'>&gt;</span> f<span class='comma'>, </span>ReaderT<span class='generics'>&lt;</span>Env<span class='comma'>, </span>M<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/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L74" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L69" class="link">Source</a>
<a href="#ReaderT_0_local_3" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand All @@ -2385,7 +2376,7 @@
<a id="ReaderT_0_with_4" class="def">with</a>
<span class='generics'>&lt;</span>Env<span class='comma'>, </span>SubEnv<span class='comma'>, </span>M<span class='comma'>, </span>A<span class='generics'>&gt;</span>
<span class='parens'>(</span>Func<span class='generics'>&lt;</span>Env<span class='comma'>, </span>SubEnv<span class='generics'>&gt;</span> f<span class='comma'>, </span>ReaderT<span class='generics'>&lt;</span>SubEnv<span class='comma'>, </span>M<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/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L78" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Monads/State and Environment Monads/Reader/ReaderT/ReaderT.Module.cs#L73" class="link">Source</a>
<a href="#ReaderT_0_with_4" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> M : Monad&lt;M&gt;, Choice&lt;M&gt;</span></div></div></p>
Expand Down
Loading

0 comments on commit 854de28

Please sign in to comment.