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 Mar 4, 2024
1 parent 14399f0 commit 01b1075
Show file tree
Hide file tree
Showing 330 changed files with 205,752 additions and 153,370 deletions.
10,051 changes: 1,359 additions & 8,692 deletions language-ext/LanguageExt.Core/Class Instances/Applicative/index.html
View file

Large diffs are not rendered by default.

974 changes: 172 additions & 802 deletions language-ext/LanguageExt.Core/Class Instances/ClassFunctions/index.html
View file

Large diffs are not rendered by default.

11,325 changes: 2,088 additions & 9,237 deletions language-ext/LanguageExt.Core/Class Instances/Eq/index.html
View file

Large diffs are not rendered by default.

198 changes: 87 additions & 111 deletions language-ext/LanguageExt.Core/Class Instances/Foldable/index.html
View file

Large diffs are not rendered by default.

3,516 changes: 495 additions & 3,021 deletions language-ext/LanguageExt.Core/Class Instances/Functor/index.html
View file

Large diffs are not rendered by default.

5,392 changes: 1,036 additions & 4,356 deletions language-ext/LanguageExt.Core/Class Instances/Hashable/index.html
View file

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions language-ext/LanguageExt.Core/Class Instances/Indexable/index.html
View file

Large diffs are not rendered by default.

23,846 changes: 2,883 additions & 20,963 deletions language-ext/LanguageExt.Core/Class Instances/Monad/index.html
View file

Large diffs are not rendered by default.

2,977 changes: 3 additions & 2,974 deletions language-ext/LanguageExt.Core/Class Instances/Monoid/index.html
View file

Large diffs are not rendered by default.

15,089 changes: 2,683 additions & 12,406 deletions language-ext/LanguageExt.Core/Class Instances/Ord/index.html
View file

Large diffs are not rendered by default.

222 changes: 39 additions & 183 deletions language-ext/LanguageExt.Core/Class Instances/Pred/Char/index.html
View file

Large diffs are not rendered by default.

132 changes: 30 additions & 102 deletions language-ext/LanguageExt.Core/Class Instances/Pred/Lst/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,40 +14,37 @@
<a href="index.html" class="link">Lst</a></p></div>

<div id="table-of-contents"><p class="caption">Contents</p>
<ul><li><a href="#LanguageExt.ClassInstances.Pred_0_AnySize_0" class="link"><div class="nowrap">AnySize
<ul><li><a href="#_0_AnySize_0" class="link"><div class="nowrap">AnySize
</div></a></li>
<ul><li><a href="#AnySize_0_Is = default(AnySize)_0" class="link"><div class="nowrap">Is = default(AnySize)</div></a></li>
<li><a href="#AnySize_0_True_0" class="link"><div class="nowrap">True
<ul><li><a href="#AnySize_0_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span></div></a></li></ul>
<li><a href="#LanguageExt.ClassInstances.Pred_0_CountRange_2" class="link"><div class="nowrap">CountRange
<span class='generics'>&lt;</span>MIN<span class='comma'>, </span>MAX<span class='generics'>&gt;</span></div></a></li>
<ul><li><a href="#CountRange_2_Is = default(CountRange<MIN, MAX>)_0" class="link"><div class="nowrap">Is = default(CountRange&lt;MIN, MAX&gt;)</div></a></li>
<li><a href="#CountRange_2_True_0" class="link"><div class="nowrap">True
<ul><li><a href="#CountRange_2_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span></div></a></li></ul>
<li><a href="#LanguageExt.ClassInstances.Pred_0_MaxCount_1" class="link"><div class="nowrap">MaxCount
<li><a href="#_0_MaxCount_1" class="link"><div class="nowrap">MaxCount
<span class='generics'>&lt;</span>MAX<span class='generics'>&gt;</span></div></a></li>
<ul><li><a href="#MaxCount_1_Is = default(MaxCount<MAX>)_0" class="link"><div class="nowrap">Is = default(MaxCount&lt;MAX&gt;)</div></a></li>
<li><a href="#MaxCount_1_True_0" class="link"><div class="nowrap">True
<ul><li><a href="#MaxCount_1_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span></div></a></li></ul>
<li><a href="#LanguageExt.ClassInstances.Pred_0_NonEmpty_0" class="link"><div class="nowrap">NonEmpty
<li><a href="#_0_NonEmpty_0" class="link"><div class="nowrap">NonEmpty
</div></a></li>
<ul><li><a href="#NonEmpty_0_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span></div></a></li></ul>
<li><a href="#LanguageExt.ClassInstances.Pred_0_NonNullItems_1" class="link"><div class="nowrap">NonNullItems
<li><a href="#_0_NonNullItems_1" class="link"><div class="nowrap">NonNullItems
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span></div></a></li>
<ul><li><a href="#NonNullItems_1_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>A value<span class='parens'>)</span></div></a></li></ul></ul></div>
<span class='parens'>(</span>A? value<span class='parens'>)</span></div></a></li></ul></ul></div>
<div class="interface">
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_AnySize_0" class="def">AnySize</a>
<a id="_0_AnySize_0" class="def">AnySize</a>

<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/AnySize.cs#L7" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_AnySize_0" class="selflink">#</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/AnySize.cs#L6" class="link">Source</a>
<a href="#_0_AnySize_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>
Expand All @@ -56,40 +53,17 @@



<div class="subs methods"><p class="caption">Fields</p>
<div class="top"><p class="src"><span class="keyword">field</span>
AnySize
<a id="AnySize_0_Is = default(AnySize)_0" class="def">Is = default(AnySize)</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/AnySize.cs#L9" class="link">Source</a>
<a href="#AnySize_0_Is = default(AnySize)_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div></div>



<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
bool
<a id="AnySize_0_True_0" class="def">True</a>

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/AnySize.cs#L11" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/AnySize.cs#L8" class="link">Source</a>
<a href="#AnySize_0_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down Expand Up @@ -117,54 +91,31 @@
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_CountRange_2" class="def">CountRange</a>
<span class='generics'>&lt;</span>MIN<span class='comma'>, </span>MAX<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/CountRange.cs#L7" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/CountRange.cs#L6" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_CountRange_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> MIN : struct, Const&lt;int&gt;
<span> MIN : Const&lt;int&gt;
</span></div>
<div class="constraint"><span class="keyword">where</span>
<span> MAX : struct, Const&lt;int&gt;</span></div></div></p>
<span> MAX : Const&lt;int&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

</div>



<div class="subs methods"><p class="caption">Fields</p>
<div class="top"><p class="src"><span class="keyword">field</span>
CountRange<span class='generics'>&lt;</span>MIN<span class='comma'>, </span>MAX<span class='generics'>&gt;</span>
<a id="CountRange_2_Is = default(CountRange<MIN, MAX>)_0" class="def">Is = default(CountRange&lt;MIN, MAX&gt;)</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/CountRange.cs#L11" class="link">Source</a>
<a href="#CountRange_2_Is = default(CountRange<MIN, MAX>)_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div></div>



<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
bool
<a id="CountRange_2_True_0" class="def">True</a>

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/CountRange.cs#L13" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/CountRange.cs#L10" class="link">Source</a>
<a href="#CountRange_2_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -190,53 +141,30 @@

</div>
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_MaxCount_1" class="def">MaxCount</a>
<a id="_0_MaxCount_1" class="def">MaxCount</a>
<span class='generics'>&lt;</span>MAX<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/MaxCount.cs#L7" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_MaxCount_1" class="selflink">#</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/MaxCount.cs#L6" class="link">Source</a>
<a href="#_0_MaxCount_1" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> MAX : struct, Const&lt;int&gt;</span></div></div></p>
<span> MAX : Const&lt;int&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

</div>



<div class="subs methods"><p class="caption">Fields</p>
<div class="top"><p class="src"><span class="keyword">field</span>
MaxCount<span class='generics'>&lt;</span>MAX<span class='generics'>&gt;</span>
<a id="MaxCount_1_Is = default(MaxCount<MAX>)_0" class="def">Is = default(MaxCount&lt;MAX&gt;)</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/MaxCount.cs#L10" class="link">Source</a>
<a href="#MaxCount_1_Is = default(MaxCount<MAX>)_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div></div>



<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
bool
<a id="MaxCount_1_True_0" class="def">True</a>

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/MaxCount.cs#L12" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/MaxCount.cs#L9" class="link">Source</a>
<a href="#MaxCount_1_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -262,10 +190,10 @@

</div>
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_NonEmpty_0" class="def">NonEmpty</a>
<a id="_0_NonEmpty_0" class="def">NonEmpty</a>

<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonEmpty.cs#L11" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_NonEmpty_0" class="selflink">#</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonEmpty.cs#L8" class="link">Source</a>
<a href="#_0_NonEmpty_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Lst must be non-empty</p>
</div>
Expand All @@ -285,7 +213,7 @@
<a id="NonEmpty_0_True_0" class="def">True</a>

<span class='parens'>(</span>ListInfo value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonEmpty.cs#L13" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonEmpty.cs#L10" class="link">Source</a>
<a href="#NonEmpty_0_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -311,10 +239,10 @@

</div>
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_NonNullItems_1" class="def">NonNullItems</a>
<a id="_0_NonNullItems_1" class="def">NonNullItems</a>
<span class='generics'>&lt;</span>A<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonNullItems.cs#L8" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_NonNullItems_1" class="selflink">#</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonNullItems.cs#L5" class="link">Source</a>
<a href="#_0_NonNullItems_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>
Expand All @@ -332,8 +260,8 @@
bool
<a id="NonNullItems_1_True_0" class="def">True</a>

<span class='parens'>(</span>A value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonNullItems.cs#L10" class="link">Source</a>
<span class='parens'>(</span>A? value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/Lst/NonNullItems.cs#L7" class="link">Source</a>
<a href="#NonNullItems_1_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down
76 changes: 14 additions & 62 deletions language-ext/LanguageExt.Core/Class Instances/Pred/String/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,27 @@
<a href="index.html" class="link">String</a></p></div>

<div id="table-of-contents"><p class="caption">Contents</p>
<ul><li><a href="#LanguageExt.ClassInstances.Pred_0_StrLen_2" class="link"><div class="nowrap">StrLen
<ul><li><a href="#_0_StrLen_2" class="link"><div class="nowrap">StrLen
<span class='generics'>&lt;</span>NMin<span class='comma'>, </span>NMax<span class='generics'>&gt;</span></div></a></li>
<ul><li><a href="#StrLen_2_Is = default(StrLen<NMin, NMax>)_0" class="link"><div class="nowrap">Is = default(StrLen&lt;NMin, NMax&gt;)</div></a></li>
<li><a href="#StrLen_2_True_0" class="link"><div class="nowrap">True
<ul><li><a href="#StrLen_2_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>string value<span class='parens'>)</span></div></a></li></ul>
<li><a href="#LanguageExt.ClassInstances.Pred_0_Matches_1" class="link"><div class="nowrap">Matches
<li><a href="#_0_Matches_1" class="link"><div class="nowrap">Matches
<span class='generics'>&lt;</span>PATTERN<span class='generics'>&gt;</span></div></a></li>
<ul><li><a href="#Matches_1_Is = default_0" class="link"><div class="nowrap">Is = default</div></a></li>
<li><a href="#Matches_1_True_0" class="link"><div class="nowrap">True
<ul><li><a href="#Matches_1_True_0" class="link"><div class="nowrap">True

<span class='parens'>(</span>string value<span class='parens'>)</span></div></a></li></ul></ul></div>
<div class="interface">
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_StrLen_2" class="def">StrLen</a>
<a id="_0_StrLen_2" class="def">StrLen</a>
<span class='generics'>&lt;</span>NMin<span class='comma'>, </span>NMax<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L8" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_StrLen_2" class="selflink">#</a>
<a href="#_0_StrLen_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> NMin : struct, Const&lt;int&gt;
</span></div>
<span> NMin : Const&lt;int&gt;
</span></div>
<div class="constraint"><span class="keyword">where</span>
<span> NMax : struct, Const&lt;int&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

</div>



<div class="subs methods"><p class="caption">Fields</p>
<div class="top"><p class="src"><span class="keyword">field</span>
StrLen<span class='generics'>&lt;</span>NMin<span class='comma'>, </span>NMax<span class='generics'>&gt;</span>
<a id="StrLen_2_Is = default(StrLen<NMin, NMax>)_0" class="def">Is = default(StrLen&lt;NMin, NMax&gt;)</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L12" class="link">Source</a>
<a href="#StrLen_2_Is = default(StrLen<NMin, NMax>)_0" class="selflink">#</a>
<div class="constraints"></div></p>
<span> NMax : Const&lt;int&gt;</span></div></div></p>
<div class="doc"><div></div>
<div></div>

Expand All @@ -62,22 +46,13 @@








</div></div>



<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
bool
<a id="StrLen_2_True_0" class="def">True</a>

<span class='parens'>(</span>string value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L14" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L12" class="link">Source</a>
<a href="#StrLen_2_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -103,10 +78,10 @@

</div>
<div class="top"><p class="src"><span class="keyword">struct</span>
<a id="LanguageExt.ClassInstances.Pred_0_Matches_1" class="def">Matches</a>
<a id="_0_Matches_1" class="def">Matches</a>
<span class='generics'>&lt;</span>PATTERN<span class='generics'>&gt;</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L19" class="link">Source</a>
<a href="#LanguageExt.ClassInstances.Pred_0_Matches_1" class="selflink">#</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L17" class="link">Source</a>
<a href="#_0_Matches_1" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> PATTERN : Const&lt;string&gt;</span></div></div></p>
<div class="doc"><div></div>
Expand All @@ -116,40 +91,17 @@



<div class="subs methods"><p class="caption">Fields</p>
<div class="top"><p class="src"><span class="keyword">field</span>
Matches<span class='generics'>&lt;</span>PATTERN<span class='generics'>&gt;</span>
<a id="Matches_1_Is = default_0" class="def">Is = default</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L22" class="link">Source</a>
<a href="#Matches_1_Is = default_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>

</div>












</div></div>



<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
bool
<a id="Matches_1_True_0" class="def">True</a>

<span class='parens'>(</span>string value<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L24" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Pred/String/Predicates.cs#L20" class="link">Source</a>
<a href="#Matches_1_True_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down
Loading

0 comments on commit 01b1075

Please sign in to comment.