Skip to content

Commit

Permalink
build based on 00a8be0
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 11, 2024
1 parent 66597ad commit 2567f27
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-11T01:39:10","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-11T01:40:04","documenter_version":"1.7.0"}}
6 changes: 3 additions & 3 deletions dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

julia> struct B end;

julia&gt; @sumtype AB(A, B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/6fd5f9dfe39ffe3da32380ee7ecacf3dd3da1d86/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
julia&gt; @sumtype AB(A, B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/00a8be0e6dd3624c274615ab842f33d0c1caa292/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

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

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

julia&gt; variant(a)
A(0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/6fd5f9dfe39ffe3da32380ee7ecacf3dd3da1d86/src/LightSumTypes.jl#L139-L160">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
A(0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/00a8be0e6dd3624c274615ab842f33d0c1caa292/src/LightSumTypes.jl#L139-L160">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

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

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

julia&gt; allvariants(AB)
(A = A, B = B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/6fd5f9dfe39ffe3da32380ee7ecacf3dd3da1d86/src/LightSumTypes.jl#L163-L182">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/6fd5f9dfe39ffe3da32380ee7ecacf3dd3da1d86/src/LightSumTypes.jl#L185-L190">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/6fd5f9dfe39ffe3da32380ee7ecacf3dd3da1d86/src/LightSumTypes.jl#L193-L198">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/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="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 11 October 2024 01:39">Friday 11 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
(A = A, B = B)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/00a8be0e6dd3624c274615ab842f33d0c1caa292/src/LightSumTypes.jl#L163-L182">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/00a8be0e6dd3624c274615ab842f33d0c1caa292/src/LightSumTypes.jl#L185-L190">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/00a8be0e6dd3624c274615ab842f33d0c1caa292/src/LightSumTypes.jl#L193-L198">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/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="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 11 October 2024 01:40">Friday 11 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/objects.inv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Sphinx inventory version 2
# Project: LightSumTypes.jl
# Version: 4.0.2
# Version: 4.1.0
# The remainder of this file is compressed using zlib.
x���KI�P(.I�J�OV�5TPp ��b�XNbRjHTYEA��'3=�$�47�� �X�,�(31�D!+�*�4/�$3?O��Ĝ��bŠ�KsK�,�����|�2T%�&0E�3���� ��4lJ�k^[

0 comments on commit 2567f27

Please sign in to comment.