Skip to content

Commit 5203834

Browse files
author
Documenter.jl
committed
build based on d70d825
1 parent 3be09ce commit 5203834

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-24T05:44:05","documenter_version":"1.14.1"}}
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-27T17:37:38","documenter_version":"1.14.1"}}

dev/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
julia> struct B end;
77

8-
julia&gt; @sumtype AB(A, B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L10-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.variant" href="#LightSumTypes.variant"><code>LightSumTypes.variant</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">variant(inst)</code></pre><p>Returns the variant enclosed in the sum type.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; using LightSumTypes
8+
julia&gt; @sumtype AB(A, B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L10-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.variant" href="#LightSumTypes.variant"><code>LightSumTypes.variant</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">variant(inst)</code></pre><p>Returns the variant enclosed in the sum type.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; using LightSumTypes
99

1010
julia&gt; struct A x::Int end;
1111

@@ -17,7 +17,7 @@
1717
AB&#39;.A(0)
1818

1919
julia&gt; variant(a)
20-
A(0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L133-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.allvariants" href="#LightSumTypes.allvariants"><code>LightSumTypes.allvariants</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">allvariants(SumType)</code></pre><p>Returns all the enclosed variants types in the sum type in a namedtuple.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; using LightSumTypes
20+
A(0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L133-L154">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.allvariants" href="#LightSumTypes.allvariants"><code>LightSumTypes.allvariants</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">allvariants(SumType)</code></pre><p>Returns all the enclosed variants types in the sum type in a namedtuple.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; using LightSumTypes
2121

2222
julia&gt; struct A x::Int end;
2323

@@ -26,4 +26,4 @@
2626
julia&gt; @sumtype AB(A, B)
2727

2828
julia&gt; allvariants(AB)
29-
(A = A, B = B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L157-L176">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.variantof" href="#LightSumTypes.variantof"><code>LightSumTypes.variantof</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">variantof(inst)</code></pre><p>Returns the type of the variant enclosed in the sum type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L179-L184">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.is_sumtype" href="#LightSumTypes.is_sumtype"><code>LightSumTypes.is_sumtype</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_sumtype(T)</code></pre><p>Returns true if the type is a sum type otherwise returns false.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L187-L192">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="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/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="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/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Sunday 24 August 2025 05:44">Sunday 24 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
29+
(A = A, B = B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L157-L176">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.variantof" href="#LightSumTypes.variantof"><code>LightSumTypes.variantof</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">variantof(inst)</code></pre><p>Returns the type of the variant enclosed in the sum type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L179-L184">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="LightSumTypes.is_sumtype" href="#LightSumTypes.is_sumtype"><code>LightSumTypes.is_sumtype</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">is_sumtype(T)</code></pre><p>Returns true if the type is a sum type otherwise returns false.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L187-L192">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="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/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="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/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Wednesday 27 August 2025 17:37">Wednesday 27 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)