Skip to content

Commit

Permalink
build based on 54e238d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 4, 2024
1 parent c741e78 commit 8b1104b
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 20 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.6.7","generation_timestamp":"2024-04-02T12:11:46","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-06-04T14:41:50","documenter_version":"1.4.1"}}
36 changes: 24 additions & 12 deletions dev/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/assets/themes/documenter-dark.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/assets/themes/documenter-light.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@
Baz(1, 2)

julia> fmap(float, model)
Baz(1.0, 2)</code></pre><p>Any field not in the list will be passed through as-is during reconstruction. This is done by invoking the default constructor, so structs that define custom inner constructors are expected to provide one that acts like the default.</p><h2 id="Appropriate-Use"><a class="docs-heading-anchor" href="#Appropriate-Use">Appropriate Use</a><a id="Appropriate-Use-1"></a><a class="docs-heading-anchor-permalink" href="#Appropriate-Use" title="Permalink"></a></h2><div class="admonition is-warning"><header class="admonition-header">Not everything should be a functor!</header><div class="admonition-body"><p>Due to its generic nature it is very attractive to mark several structures as <a href="api/#Functors.@functor"><code>@functor</code></a> when it may not be quite safe to do so.</p></div></div><p>Typically, since any function <code>f</code> is applied to the leaves of the tree, but it is possible for some functions to require dispatching on the specific type of the fields causing some methods to be missed entirely.</p><p>Examples of this include element types of arrays which typically have their own mathematical operations defined. Adding a <a href="api/#Functors.@functor"><code>@functor</code></a> to such a type would end up missing methods such as <code>+(::MyElementType, ::MyElementType)</code>. Think <code>RGB</code> from Colors.jl.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</a><div class="flexbox-break"></div><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 2 April 2024 12:11">Tuesday 2 April 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Baz(1.0, 2)</code></pre><p>Any field not in the list will be passed through as-is during reconstruction. This is done by invoking the default constructor, so structs that define custom inner constructors are expected to provide one that acts like the default.</p><h2 id="Appropriate-Use"><a class="docs-heading-anchor" href="#Appropriate-Use">Appropriate Use</a><a id="Appropriate-Use-1"></a><a class="docs-heading-anchor-permalink" href="#Appropriate-Use" title="Permalink"></a></h2><div class="admonition is-warning"><header class="admonition-header">Not everything should be a functor!</header><div class="admonition-body"><p>Due to its generic nature it is very attractive to mark several structures as <a href="api/#Functors.@functor"><code>@functor</code></a> when it may not be quite safe to do so.</p></div></div><p>Typically, since any function <code>f</code> is applied to the leaves of the tree, but it is possible for some functions to require dispatching on the specific type of the fields causing some methods to be missed entirely.</p><p>Examples of this include element types of arrays which typically have their own mathematical operations defined. Adding a <a href="api/#Functors.@functor"><code>@functor</code></a> to such a type would end up missing methods such as <code>+(::MyElementType, ::MyElementType)</code>. Think <code>RGB</code> from Colors.jl.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</a><div class="flexbox-break"></div><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Tuesday 4 June 2024 14:41">Tuesday 4 June 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
7 changes: 4 additions & 3 deletions dev/objects.inv
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Sphinx inventory version 2
# Project: Functors.jl
# Version: 0.4.9
# Version: 0.4.10
# The remainder of this file is compressed using zlib.
x���MO�0 �����c��8��1@LiB'/q�li%)���4[�N[�rk�ǯ��.� ��:6b���7U`��/��L���9�<�,Q4ѫk�&� 6�#�;"S%�3%u��$Ks�e�6L<L�p�Z�py������.cO`9M�,�0T�Z`�ҁ�J�i�<�?œ��Fi����ij�V܋���8�}��@�"{����a�c�
�+]�g���z��H%�B���SM�J�E�3(��r�@�A�����d�{���h;8v���̡�=�:�*!��_���4 �h���6�� ����/w�b�H�@sd�9�壢�6c��r�C7���h�3(�{��o�C��n������EZ��F�4�ȟ
x���MO�0 ���Al�C�vb B����K�5[�DI
�';:�mʭ��~c�L$�%�&�DR�y�9F�X��o�d>�ޱ���|���!z= q�|cZb.�%2��X]P+��A$q�\�n����dG���7k~��k|�j3������
}�Y�8�(,X&Ņ�lj�}�s<�(��� ,:M�H�ŝ�l�,�k�Y�qZ�W��N�����?��W����"u�pw`jy��`S�A�)�\�tE�Ra#��)���#�� V~�R^$�{tzig<Pwp�Z���E�t0��#���oq����O����m�^��f�^#��0 ϩ.e�0�N,�w��A�f�'Ex���-�cH)�M���t�H ���?�ߺ
Expand Down
2 changes: 1 addition & 1 deletion dev/search_index.js

Large diffs are not rendered by default.

0 comments on commit 8b1104b

Please sign in to comment.