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 Dec 17, 2024
1 parent 854de28 commit bded246
Show file tree
Hide file tree
Showing 66 changed files with 1,023 additions and 974 deletions.
2 changes: 1 addition & 1 deletion language-ext/LanguageExt.Core/Async/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<div class="doc"><div><p>The <code>Async</code> module helps transition away from the <code>Task</code> / <code>async</code> / <code>await</code> world and into one
where awaiting is the default setting for concurrent programming and branching/forking is the
thing we do the least.</p>
<p>The <code>Async.await</code> function will convert a <code>Task&lt;A&gt;</code> into an <code>A</code> by waiting for the <code>Task</code> to
<p>The <code>Async.await</code> function will convert a <code>Task〈A〉</code> into an <code>A</code> by waiting for the <code>Task</code> to
complete; it will yield the thread whilst it's waiting (to play nice with other tasks in the
task-pool). This is just like the regular <code>await</code> keyword without all the ceremony and
colouring of methods.</p>
Expand Down
6 changes: 3 additions & 3 deletions language-ext/LanguageExt.Core/Class Instances/Eq/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1573,7 +1573,7 @@
<a href="#_0_EqDefault_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Finds an appropriate Eq from the loaded assemblies, if one can't be found then it
falls back to the standard .NET EqualityComparer<A>.Default.Equals(a,b) method to
falls back to the standard .NET EqualityComparer〈A〉.Default.Equals(a,b) method to
provide equality testing.</p>
</div>
<div></div>
Expand Down Expand Up @@ -4503,7 +4503,7 @@
<a href="#_0_EqSet_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> EQ : Eq&lt;A&gt;</span></div></div></p>
<div class="doc"><div><p>Set<T> equality</p>
<div class="doc"><div><p>Set〈T〉 equality</p>
</div>
<div></div>

Expand Down Expand Up @@ -4597,7 +4597,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Eq/EqSet.cs#L47" class="link">Source</a>
<a href="#_0_EqSet_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Set<T> equality</p>
<div class="doc"><div><p>Set〈T〉 equality</p>
</div>
<div></div>

Expand Down
4 changes: 2 additions & 2 deletions language-ext/LanguageExt.Core/Class Instances/Hashable/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2685,7 +2685,7 @@
<a href="#_0_HashableSet_2" class="selflink">#</a>
<div class="constraints"><div class="constraint"><span class="keyword">where</span>
<span> HashA : Hashable&lt;A&gt;</span></div></div></p>
<div class="doc"><div><p>Set<T> hashing</p>
<div class="doc"><div><p>Set〈T〉 hashing</p>
</div>
<div></div>

Expand Down Expand Up @@ -2742,7 +2742,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Hashable/HashableSet.cs#L23" class="link">Source</a>
<a href="#_0_HashableSet_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Set<T> hashing</p>
<div class="doc"><div><p>Set〈T〉 hashing</p>
</div>
<div></div>

Expand Down
2 changes: 1 addition & 1 deletion language-ext/LanguageExt.Core/Class Instances/Ord/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1757,7 +1757,7 @@
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Class Instances/Ord/OrdDefault.cs#L11" class="link">Source</a>
<a href="#_0_OrdDefault_1" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Uses the standard .NET Comparer<A>.Default.Compare(a,b) method to
<div class="doc"><div><p>Uses the standard .NET Comparer〈A〉.Default.Compare(a,b) method to
provide equality testing.</p>
</div>
<div></div>
Expand Down
68 changes: 34 additions & 34 deletions language-ext/LanguageExt.Core/Class Instances/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1149,7 +1149,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -1182,7 +1182,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -1215,7 +1215,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -1248,7 +1248,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -1607,9 +1607,9 @@
<a href="#_0_TBool_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Bool class instance. Implements</p>
<pre class='language-csharp'><code>Eq&lt;bool&gt;
Ord&lt;bool&gt;
Bool&lt;bool&gt;
<pre class='language-csharp'><code>Eq〈bool〉
Ord〈bool〉
Bool〈bool〉
</code></pre>
</div>
<div></div>
Expand Down Expand Up @@ -1973,9 +1973,9 @@
<a href="#_0_TBoolBool_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>TBoolBool class instance. Implements</p>
<pre class='language-csharp'><code>Eq&lt;(bool, bool)&gt;
Ord&lt;(bool, bool)&gt;
Bool&lt;(bool, bool)&gt;
<pre class='language-csharp'><code>Eq〈(bool, bool)〉
Ord〈(bool, bool)〉
Bool〈(bool, bool)〉
</code></pre>
</div>
<div></div>
Expand Down Expand Up @@ -2886,7 +2886,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -2919,7 +2919,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -2952,7 +2952,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -2985,7 +2985,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -4017,7 +4017,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -4050,7 +4050,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -4083,7 +4083,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -4116,7 +4116,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -5148,7 +5148,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -5181,7 +5181,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -5214,7 +5214,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -5247,7 +5247,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -6280,7 +6280,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -6313,7 +6313,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -6346,7 +6346,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -6379,7 +6379,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -7020,7 +7020,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -7053,7 +7053,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -7086,7 +7086,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -7119,7 +7119,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -8164,7 +8164,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The integer to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -8197,7 +8197,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The float to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -8230,7 +8230,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The double to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down Expand Up @@ -8263,7 +8263,7 @@
<td class="src clearfix"><span class="instruction inst-left"><p>The decimal to use</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>The equivalent of x in the Num<A></p>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>The equivalent of x in the Num〈A〉</p>
</span></td></tr></tbody></table></div></div>
</div>

Expand Down
Loading

0 comments on commit bded246

Please sign in to comment.