build based on 8e80469

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.0-DEV.1592","generation_timestamp":"2024-02-14T07:49:49","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.11.0-DEV.1592","generation_timestamp":"2024-02-14T07:57:29","documenter_version":"1.2.1"}}

dev/generated-plugin-examples/dispatch_analysis/index.html

@@ -227,4 +227,4 @@
 <span class="sgr91">┌ </span><span class="sgr1">compute(</span><span class="sgr90">x</span>::Int64<span class="sgr1">)</span> <span class="sgr91">@ Main ./timing.jl:319</span>
 <span class="sgr91">│ runtime dispatch detected: </span><span class="sgr1">Core.kwcall([quote]<span class="sgr96">::@NamedTuple{msg::Nothing}</span>, Base.time_print, %140<span class="sgr96">::IO</span>, %134<span class="sgr96">::Float64</span>, %112<span class="sgr96">::Int64</span>, %127<span class="sgr96">::Int64</span>, %137<span class="sgr96">::Int64</span>, %89<span class="sgr96">::Int64</span>, %138<span class="sgr96">::Float64</span>, %139<span class="sgr96">::Float64</span>, true)<span class="sgr96">::Any</span></span>
 <span class="sgr91">└────────────────────</span>
-</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../generated-plugin-api/">« API</a><a class="docs-footer-nextpage" href="../find_unstable_api/">&quot;Unstable API&quot; Analysis »</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:49">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../generated-plugin-api/">« API</a><a class="docs-footer-nextpage" href="../find_unstable_api/">&quot;Unstable API&quot; Analysis »</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:57">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/generated-plugin-examples/find_unstable_api/index.html

@@ -160,4 +160,4 @@
 │││││ usage of unstable API `Base.uncompressed_ast` found
 ││││└─────────────────────────────────────────────────────────────────────────────────
 ││││┌ @ /Users/aviatesk/.julia/packages/IRTools/aSVI5/src/reflection/reflection.jl:54
-... # many other &quot;unstable API&quot;s detected</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dispatch_analysis/">« Dispatch Analysis</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:49">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+... # many other &quot;unstable API&quot;s detected</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dispatch_analysis/">« Dispatch Analysis</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:57">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -33,7 +33,7 @@
 <span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">┌ </span><span class="sgr1">reduce_empty(</span><span class="sgr90">op</span>::Base.BottomRF<span class="sgr90">{typeof(+)}</span>, ::Type<span class="sgr90">{Char}</span><span class="sgr1">)</span> <span class="sgr35">@ Base ./reduce.jl:357</span>
 <span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr91">┌ </span><span class="sgr1">reduce_empty(</span>::typeof(+), ::Type<span class="sgr90">{Char}</span><span class="sgr1">)</span> <span class="sgr91">@ Base ./reduce.jl:343</span>
 <span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr91">│ no matching method found `zero(::Type{Char})`: </span><span class="sgr1">zero(T<span class="sgr96">::Type{Char}</span>)</span>
-<span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr91">└────────────────────</span></code></pre><h3 id="Analyze-packages-with-[report_package](@ref)"><a class="docs-heading-anchor" href="#Analyze-packages-with-[report_package](@ref)">Analyze packages with <a href="jetanalysis/#JET.report_package"><code>report_package</code></a></a><a id="Analyze-packages-with-[report_package](@ref)-1"></a><a class="docs-heading-anchor-permalink" href="#Analyze-packages-with-[report_package](@ref)" title="Permalink"></a></h3><p>This looks for all method definitions and analyses function calls based on their signatures. Note that this is less accurate than <a href="jetanalysis/#JET.@report_call"><code>@report_call</code></a>, because the actual input types cannot be known for generic methods.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg; Pkg.activate(; temp=true, io=devnull); Pkg.add(&quot;AbstractTrees&quot;; io=devnull);</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.status()</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1">Status</span></span> `/tmp/jl_hfMdtX/Project.toml`
+<span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr34">│</span><span class="sgr33">│</span><span class="sgr32">│</span><span class="sgr35">│</span><span class="sgr91">└────────────────────</span></code></pre><h3 id="Analyze-packages-with-[report_package](@ref)"><a class="docs-heading-anchor" href="#Analyze-packages-with-[report_package](@ref)">Analyze packages with <a href="jetanalysis/#JET.report_package"><code>report_package</code></a></a><a id="Analyze-packages-with-[report_package](@ref)-1"></a><a class="docs-heading-anchor-permalink" href="#Analyze-packages-with-[report_package](@ref)" title="Permalink"></a></h3><p>This looks for all method definitions and analyses function calls based on their signatures. Note that this is less accurate than <a href="jetanalysis/#JET.@report_call"><code>@report_call</code></a>, because the actual input types cannot be known for generic methods.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg; Pkg.activate(; temp=true, io=devnull); Pkg.add(&quot;AbstractTrees&quot;; io=devnull);</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.status()</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1">Status</span></span> `/tmp/jl_PG5QDi/Project.toml`
   <span class="sgr90">[1520ce14] </span>AbstractTrees v0.4.4</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; report_package(&quot;AbstractTrees&quot;; toplevel_logger=nothing)</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr7">═════ 9 possible errors found ═════</span>
 <span class="sgr91">┌ </span><span class="sgr1">isroot(</span><span class="sgr90">root</span>::Any, <span class="sgr90">x</span>::Any<span class="sgr1">)</span> <span class="sgr91">@ AbstractTrees /home/runner/.julia/packages/AbstractTrees/EUx8s/src/base.jl:102</span>
 <span class="sgr91">│ no matching method found `parent(::Any, ::Any)`: </span><span class="sgr1">AbstractTrees.parent(root<span class="sgr96">::Any</span>, x<span class="sgr96">::Any</span>)</span>
@@ -66,4 +66,4 @@
 <span class="sgr91">└────────────────────</span>
 <span class="sgr91">┌ </span><span class="sgr1">(::AbstractTrees.var&quot;#17#18&quot;)(</span><span class="sgr90">n</span>::Any<span class="sgr1">)</span> <span class="sgr91">@ AbstractTrees /home/runner/.julia/packages/AbstractTrees/EUx8s/src/iteration.jl:323</span>
 <span class="sgr91">│ no matching method found `parent(::Any, ::Any)`: </span><span class="sgr1">AbstractTrees.parent(getfield(#self#<span class="sgr96">::AbstractTrees.var&quot;#17#18&quot;</span>, :tree)<span class="sgr96">::Any</span>, n<span class="sgr96">::Any</span>)</span>
-<span class="sgr91">└────────────────────</span></code></pre><h2 id="Limitations"><a class="docs-heading-anchor" href="#Limitations">Limitations</a><a id="Limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Limitations" title="Permalink"></a></h2><p>JET explores the functions you call directly as well as their <em>inferable</em> callees. However, if the argument types for a call cannot be inferred, JET does not analyze the callee. Consequently, a report of <code>No errors detected</code> does not imply that your entire codebase is free of errors. To increase the confidence in JET&#39;s results use <a href="optanalysis/#JET.@report_opt"><code>@report_opt</code></a> to make sure your code is inferrible.</p><p>JET integrates with <a href="https://github.com/timholy/SnoopCompile.jl">SnoopCompile</a>, and you can sometimes use SnoopCompile to collect the data to perform more comprehensive analyses. SnoopCompile&#39;s limitation is that it only collects data for calls that have not been previously inferred, so you must perform this type of analysis in a fresh session.</p><p>See <a href="https://timholy.github.io/SnoopCompile.jl/stable/jet/">SnoopCompile&#39;s JET-integration documentation</a> for further details.</p><h2 id="Acknowledgement"><a class="docs-heading-anchor" href="#Acknowledgement">Acknowledgement</a><a id="Acknowledgement-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgement" title="Permalink"></a></h2><p>This project started as my undergrad thesis project at Kyoto University, supervised by Prof. Takashi Sakuragawa. We were heavily inspired by <a href="https://github.com/ruby/typeprof">ruby/typeprof</a>, an experimental type understanding/checking tool for Ruby. The grad thesis about this project is published at <a href="https://github.com/aviatesk/grad-thesis">https://github.com/aviatesk/grad-thesis</a>, but currently, it&#39;s only available in Japanese.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:49">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<span class="sgr91">└────────────────────</span></code></pre><h2 id="Limitations"><a class="docs-heading-anchor" href="#Limitations">Limitations</a><a id="Limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Limitations" title="Permalink"></a></h2><p>JET explores the functions you call directly as well as their <em>inferable</em> callees. However, if the argument types for a call cannot be inferred, JET does not analyze the callee. Consequently, a report of <code>No errors detected</code> does not imply that your entire codebase is free of errors. To increase the confidence in JET&#39;s results use <a href="optanalysis/#JET.@report_opt"><code>@report_opt</code></a> to make sure your code is inferrible.</p><p>JET integrates with <a href="https://github.com/timholy/SnoopCompile.jl">SnoopCompile</a>, and you can sometimes use SnoopCompile to collect the data to perform more comprehensive analyses. SnoopCompile&#39;s limitation is that it only collects data for calls that have not been previously inferred, so you must perform this type of analysis in a fresh session.</p><p>See <a href="https://timholy.github.io/SnoopCompile.jl/stable/jet/">SnoopCompile&#39;s JET-integration documentation</a> for further details.</p><h2 id="Acknowledgement"><a class="docs-heading-anchor" href="#Acknowledgement">Acknowledgement</a><a id="Acknowledgement-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgement" title="Permalink"></a></h2><p>This project started as my undergrad thesis project at Kyoto University, supervised by Prof. Takashi Sakuragawa. We were heavily inspired by <a href="https://github.com/ruby/typeprof">ruby/typeprof</a>, an experimental type understanding/checking tool for Ruby. The grad thesis about this project is published at <a href="https://github.com/aviatesk/grad-thesis">https://github.com/aviatesk/grad-thesis</a>, but currently, it&#39;s only available in Japanese.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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.1 on <span class="colophon-date" title="Wednesday 14 February 2024 07:57">Wednesday 14 February 2024</span>. Using Julia version 1.11.0-DEV.1592.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>