build based on 1de7ad7

previews/PR255/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-01T03:14:55","documenter_version":"1.2.0"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-01T15:28:57","documenter_version":"1.2.0"}}

previews/PR255/ambiguities/index.html

@@ -9,4 +9,4 @@
 
 Possible fix, define
   f(::Int64, ::Int64)</code></pre><p>This will throw an <code>MethodError</code> because both methods are equally specific. The solution is to add a third method:</p><pre><code class="language-julia hljs">f(x::Int, y::Int) = ? # `?` is dependent on the use case, most times it will be `1` or `2`</code></pre><h2 id="test_ambiguities"><a class="docs-heading-anchor" href="#test_ambiguities">Test function</a><a id="test_ambiguities-1"></a><a class="docs-heading-anchor-permalink" href="#test_ambiguities" title="Permalink"></a></h2><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="Aqua.test_ambiguities" href="#Aqua.test_ambiguities"><code>Aqua.test_ambiguities</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">test_ambiguities(package::Union{Module, PkgId})
-test_ambiguities(packages::Vector{Union{Module, PkgId}})</code></pre><p>Test that there is no method ambiguities in given package(s).  It calls <code>Test.detect_ambiguities</code> in a separated clean process to avoid false-positives.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>broken::Bool = false</code>: If true, it uses <code>@test_broken</code> instead of <code>@test</code>.</li><li><code>color::Union{Bool, Nothing} = nothing</code>: Enable/disable colorful output if a <code>Bool</code>.  <code>nothing</code> (default) means to inherit the setting in the current process.</li><li><code>exclude::AbstractVector = []</code>: A vector of functions or types to be excluded from ambiguity testing.  A function means to exclude <em>all</em> its methods.  A type means to exclude <em>all</em> its methods of the callable (sometimes also called &quot;functor&quot;) and the constructor.   That is to say, <code>MyModule.MyType</code> means to ignore ambiguities between  <code>(::MyType)(x, y::Int)</code> and <code>(::MyType)(x::Int, y)</code>.</li><li><code>recursive::Bool = true</code>: Passed to <code>Test.detect_ambiguities</code>. Note that the default here (<code>true</code>) is different from <code>detect_ambiguities</code>.  This is for testing ambiguities in methods defined in all sub-modules.</li><li>Other keyword arguments such as <code>imported</code> and <code>ambiguous_bottom</code> are passed to <code>Test.detect_ambiguities</code> as-is.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaTesting/Aqua.jl/blob/3cf8081a5444c98a2c8001af0643ec008515e6e1/src/ambiguities.jl#L1-L27">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../test_all/">« Test everything</a><a class="docs-footer-nextpage" href="../unbound_args/">Unbound Type Parameters »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.0 on <span class="colophon-date" title="Friday 1 December 2023 03:14">Friday 1 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+test_ambiguities(packages::Vector{Union{Module, PkgId}})</code></pre><p>Test that there is no method ambiguities in given package(s).  It calls <code>Test.detect_ambiguities</code> in a separated clean process to avoid false-positives.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>broken::Bool = false</code>: If true, it uses <code>@test_broken</code> instead of <code>@test</code>.</li><li><code>color::Union{Bool, Nothing} = nothing</code>: Enable/disable colorful output if a <code>Bool</code>.  <code>nothing</code> (default) means to inherit the setting in the current process.</li><li><code>exclude::AbstractVector = []</code>: A vector of functions or types to be excluded from ambiguity testing.  A function means to exclude <em>all</em> its methods.  A type means to exclude <em>all</em> its methods of the callable (sometimes also called &quot;functor&quot;) and the constructor.   That is to say, <code>MyModule.MyType</code> means to ignore ambiguities between  <code>(::MyType)(x, y::Int)</code> and <code>(::MyType)(x::Int, y)</code>.</li><li><code>recursive::Bool = true</code>: Passed to <code>Test.detect_ambiguities</code>. Note that the default here (<code>true</code>) is different from <code>detect_ambiguities</code>.  This is for testing ambiguities in methods defined in all sub-modules.</li><li>Other keyword arguments such as <code>imported</code> and <code>ambiguous_bottom</code> are passed to <code>Test.detect_ambiguities</code> as-is.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaTesting/Aqua.jl/blob/1de7ad7a7e3cbb23441812de22a1a3a3b9828f59/src/ambiguities.jl#L1-L27">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../test_all/">« Test everything</a><a class="docs-footer-nextpage" href="../unbound_args/">Unbound Type Parameters »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.0 on <span class="colophon-date" title="Friday 1 December 2023 15:28">Friday 1 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>