Skip to content

Commit

Permalink
build based on c59aebd
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 24, 2024
1 parent f273ff1 commit efc54c1
Show file tree
Hide file tree
Showing 61 changed files with 189 additions and 187 deletions.
2 changes: 1 addition & 1 deletion dev/adv/adv/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/adv/errors_tracebacks/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
)</code></pre><p>but you can also do more, if you just want to quickly change some options (e.g. to deal with a particularly though bug). You can set flags to change the behavior on the fly:</p><pre><code class="language-julia hljs">import Term: STACKTRACE_HIDDEN_MODULES, STACKTRACE_HIDE_FRAMES

STACKTRACE_HIDDEN_MODULES[] = [&quot;REPL&quot;, &quot;OhMyREPL&quot;] # list names of modules you want ignored in the stacktrace
STACKTRACE_HIDE_FRAMES[] = false # set to true to hide frame, false to show all of them</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">false</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../logging/">« Logging</a><a class="docs-footer-nextpage" href="../introspection/">Introspection »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 24 April 2024 13:07">Wednesday 24 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
STACKTRACE_HIDE_FRAMES[] = false # set to true to hide frame, false to show all of them</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">false</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../logging/">« Logging</a><a class="docs-footer-nextpage" href="../introspection/">Introspection »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 24 April 2024 13:09">Wednesday 24 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/adv/introspection/index.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/adv/logging/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">│</span></span> <span class="sgr38_2" style="color:#ce93d8"><span class="sgr2">String </span></span> <span class="sgr37">n </span> <span class="sgr38_2" style="color:#ef5350">=</span> a string<span class="sgr38_2" style="color:#ef5350">!</span>
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">│</span></span> <span class="sgr38_2" style="color:#ce93d8"><span class="sgr2">Symbol </span></span> <span class="sgr38_2" style="color:#ffa726">:x</span> <span class="sgr38_2" style="color:#ef5350">=</span> x
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">╰────────────────────────────────────────────────</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:07:12</span></span></code></pre><p>As you can see, it shows all the information that is normally there, an more! If your log macro is called from within a function, it will also tell you that:</p><pre><code class="language-julia hljs">function my_useful_function()
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:08:50</span></span></code></pre><p>As you can see, it shows all the information that is normally there, an more! If your log macro is called from within a function, it will also tell you that:</p><pre><code class="language-julia hljs">function my_useful_function()
@info &quot;My log message&quot; 1+1 n=&quot;a string!&quot; :x
end

Expand All @@ -18,17 +18,17 @@
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">│</span></span> <span class="sgr38_2" style="color:#ce93d8"><span class="sgr2">String </span></span> <span class="sgr37">n </span> <span class="sgr38_2" style="color:#ef5350">=</span> a string<span class="sgr38_2" style="color:#ef5350">!</span>
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">│</span></span> <span class="sgr38_2" style="color:#ce93d8"><span class="sgr2">Symbol </span></span> <span class="sgr38_2" style="color:#ffa726">:x</span> <span class="sgr38_2" style="color:#ef5350">=</span> x
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">╰────────────────────────────────────────────────</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:07:12</span></span></code></pre><p>And of course it works nicely with all logging macros:</p><pre><code class="language-julia hljs">@info &quot;just some info&quot;
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:08:51</span></span></code></pre><p>And of course it works nicely with all logging macros:</p><pre><code class="language-julia hljs">@info &quot;just some info&quot;
@warn &quot;careful!&quot;
@error &quot;uh oh, not good!&quot;</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr38_2" style="color:#7cb0cf"><span class="sgr4"><span class="sgr1">@Info</span></span></span> <span class="sgr38_2" style="color:#f2d777">(Main):</span> <span class="sgr38_2" style="color:#8abeff">just some info </span>
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">│</span></span>
<span class="sgr38_2" style="color:#7cb0cf"><span class="sgr2">╰────────────────────────────────────────────────</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:07:12</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:08:51</span></span>
<span class="sgr38_2" style="color:#ffa726"><span class="sgr4"><span class="sgr1">@Warn</span></span></span> <span class="sgr38_2" style="color:#f2d777">(Main):</span> <span class="sgr38_2" style="color:#8abeff">careful! </span>
<span class="sgr38_2" style="color:#ffa726"><span class="sgr2">│</span></span>
<span class="sgr38_2" style="color:#ffa726"><span class="sgr2">╰────────────────────────────────────────────────</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:07:13</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:08:51</span></span>
<span class="sgr38_2" style="color:#d13f3f"><span class="sgr4"><span class="sgr1">@Error</span></span></span> <span class="sgr38_2" style="color:#f2d777">(Main):</span> <span class="sgr38_2" style="color:#8abeff">uh oh, not good! </span>
<span class="sgr38_2" style="color:#d13f3f"><span class="sgr2">│</span></span>
<span class="sgr38_2" style="color:#d13f3f"><span class="sgr2">╰────────────────────────────────────────────────</span></span>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:07:13</span></span></code></pre><div class="admonition is-warning"><header class="admonition-header">not for developers</header><div class="admonition-body"><p>Setting up Term&#39;s loggers will change this behavior for any downstream user of your code. While this could be okay, it might be surprising and undesirable for some, so do at your own risk. </p></div></div><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p>You can revert to the original logger using <code>uninstall_term_logger</code>.</p></div></div><div class="admonition is-success"><header class="admonition-header">Term and other log outputs</header><div class="admonition-body"><p>See <a href="https://discourse.julialang.org/t/term-jl-logging-sending-messages-to-multiple-locations/84841">here</a> for some info on how to use Term&#39;s logger in conjunction with other logging outputs.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../progressbars/">« Progress bars</a><a class="docs-footer-nextpage" href="../errors_tracebacks/">Errors »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 24 April 2024 13:08">Wednesday 24 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<span class="sgr2">Wed, 24 Apr 2024</span> <span class="sgr4"><span class="sgr2">13:08:51</span></span></code></pre><div class="admonition is-warning"><header class="admonition-header">not for developers</header><div class="admonition-body"><p>Setting up Term&#39;s loggers will change this behavior for any downstream user of your code. While this could be okay, it might be surprising and undesirable for some, so do at your own risk. </p></div></div><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p>You can revert to the original logger using <code>uninstall_term_logger</code>.</p></div></div><div class="admonition is-success"><header class="admonition-header">Term and other log outputs</header><div class="admonition-body"><p>See <a href="https://discourse.julialang.org/t/term-jl-logging-sending-messages-to-multiple-locations/84841">here</a> for some info on how to use Term&#39;s logger in conjunction with other logging outputs.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../progressbars/">« Progress bars</a><a class="docs-footer-nextpage" href="../errors_tracebacks/">Errors »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 24 April 2024 13:09">Wednesday 24 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit efc54c1

Please sign in to comment.