build based on 2b95a78

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-13T11:45:53","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-20T15:22:01","documenter_version":"1.7.0"}}

dev/91-developer/index.html

@@ -25,4 +25,4 @@
 - Alice
 {% if AddBob %}- Bob{% endif}
 - Carlos
-- Diana</code></pre><h3 id="Dependent-files-and-directories"><a class="docs-heading-anchor" href="#Dependent-files-and-directories">Dependent files and directories</a><a id="Dependent-files-and-directories-1"></a><a class="docs-heading-anchor-permalink" href="#Dependent-files-and-directories" title="Permalink"></a></h3><p>To make a file depend on a variable, you can change the name of the file to include the conditional and the <code>.jinja</code> extension.</p><pre><code class="language-jinja hljs">{% if AddSomeFile %}some-file.txt{% endif %}.jinja</code></pre><p>If <code>AddSomeFile</code>, then <code>some-file.txt</code> will exist.</p><p>For directories, you do the same, except that you don&#39;t add the <code>.jinja</code> extension.</p><pre><code class="language-jinja hljs">{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}</code></pre><h3 id="Using-answers"><a class="docs-heading-anchor" href="#Using-answers">Using answers</a><a id="Using-answers-1"></a><a class="docs-heading-anchor-permalink" href="#Using-answers" title="Permalink"></a></h3><p>To use the answers of a question outside of a conditional, you can use <code>{{ SomeValue }}</code>. This will translate to the value of <code>SomeValue</code> as answered by the user. For instance</p><pre><code class="language-jinja hljs">whoami() = &quot;Hi, I&#39;m package {{ PackageName }}.jl&quot;</code></pre><p>This also works on file names and in the <code>copier.yml</code> file.</p><h3 id="Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files"><a class="docs-heading-anchor" href="#Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files">Raw tag and avoiding clashes in GitHub workflow files</a><a id="Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files-1"></a><a class="docs-heading-anchor-permalink" href="#Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files" title="Permalink"></a></h3><p>Since the GitHub workflow also uses <code>{</code> and <code>}</code> for their commands, we want to enclose them using the <code>{% raw %}...{% endraw %}</code> tag:</p><pre><code class="language-jinja hljs">os: {% raw %}%{{ matrix.os }}{% endraw %}</code></pre><h2 id="Removing/replacing-a-question"><a class="docs-heading-anchor" href="#Removing/replacing-a-question">Removing/replacing a question</a><a id="Removing/replacing-a-question-1"></a><a class="docs-heading-anchor-permalink" href="#Removing/replacing-a-question" title="Permalink"></a></h2><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>This has only been tested with a single change</p></div></div><p>Before removing a question, we should deprecate it for one major release. We also want to ensure a smooth transition when the user updates.</p><p>Luckily, we do have one test that minimally simulates this situation: &quot;Test updating from main to HEAD vs generate in HEAD&quot; inside file <code>test/test-bestie-specific-api</code>.</p><p>This test will run <code>generate</code> using the local <code>main</code> branch (which won&#39;t contain the changes), and run the <code>update</code> command, with <code>defaults=true</code>, and then compare the result to running <code>generate</code> directly.</p><ul><li>Change the <code>help</code> field to start with &quot;(Deprecated in VERSION)&quot; (VERSION should be the next major release)</li><li>Set <code>when: false</code> in the question</li><li>Update the CHANGELOG<ul><li>Entry in <code>Deprecated</code> section</li><li>Add or update a &quot;Breaking notice&quot; in the beginning to inform of the changes</li></ul></li><li>Move the default questions answers in <code>src/debug/Data.jl</code> to the <code>deprecated</code> dictionary.</li><li>Make sure that nothing depends on the old question</li><li>If necessary, change some <code>default</code> values to use the deprecated questions, to ensure a smooth transition.</li><li>Remove the question in the next release</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../90-contributing/">« Contributing guidelines</a><a class="docs-footer-nextpage" href="../95-reference/">Reference »</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><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 13 September 2024 11:45">Friday 13 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+- Diana</code></pre><h3 id="Dependent-files-and-directories"><a class="docs-heading-anchor" href="#Dependent-files-and-directories">Dependent files and directories</a><a id="Dependent-files-and-directories-1"></a><a class="docs-heading-anchor-permalink" href="#Dependent-files-and-directories" title="Permalink"></a></h3><p>To make a file depend on a variable, you can change the name of the file to include the conditional and the <code>.jinja</code> extension.</p><pre><code class="language-jinja hljs">{% if AddSomeFile %}some-file.txt{% endif %}.jinja</code></pre><p>If <code>AddSomeFile</code>, then <code>some-file.txt</code> will exist.</p><p>For directories, you do the same, except that you don&#39;t add the <code>.jinja</code> extension.</p><pre><code class="language-jinja hljs">{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}</code></pre><h3 id="Using-answers"><a class="docs-heading-anchor" href="#Using-answers">Using answers</a><a id="Using-answers-1"></a><a class="docs-heading-anchor-permalink" href="#Using-answers" title="Permalink"></a></h3><p>To use the answers of a question outside of a conditional, you can use <code>{{ SomeValue }}</code>. This will translate to the value of <code>SomeValue</code> as answered by the user. For instance</p><pre><code class="language-jinja hljs">whoami() = &quot;Hi, I&#39;m package {{ PackageName }}.jl&quot;</code></pre><p>This also works on file names and in the <code>copier.yml</code> file.</p><h3 id="Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files"><a class="docs-heading-anchor" href="#Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files">Raw tag and avoiding clashes in GitHub workflow files</a><a id="Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files-1"></a><a class="docs-heading-anchor-permalink" href="#Raw-tag-and-avoiding-clashes-in-GitHub-workflow-files" title="Permalink"></a></h3><p>Since the GitHub workflow also uses <code>{</code> and <code>}</code> for their commands, we want to enclose them using the <code>{% raw %}...{% endraw %}</code> tag:</p><pre><code class="language-jinja hljs">os: {% raw %}%{{ matrix.os }}{% endraw %}</code></pre><h2 id="Removing/replacing-a-question"><a class="docs-heading-anchor" href="#Removing/replacing-a-question">Removing/replacing a question</a><a id="Removing/replacing-a-question-1"></a><a class="docs-heading-anchor-permalink" href="#Removing/replacing-a-question" title="Permalink"></a></h2><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>This has only been tested with a single change</p></div></div><p>Before removing a question, we should deprecate it for one major release. We also want to ensure a smooth transition when the user updates.</p><p>Luckily, we do have one test that minimally simulates this situation: &quot;Test updating from main to HEAD vs generate in HEAD&quot; inside file <code>test/test-bestie-specific-api</code>.</p><p>This test will run <code>generate</code> using the local <code>main</code> branch (which won&#39;t contain the changes), and run the <code>update</code> command, with <code>defaults=true</code>, and then compare the result to running <code>generate</code> directly.</p><ul><li>Change the <code>help</code> field to start with &quot;(Deprecated in VERSION)&quot; (VERSION should be the next major release)</li><li>Set <code>when: false</code> in the question</li><li>Update the CHANGELOG<ul><li>Entry in <code>Deprecated</code> section</li><li>Add or update a &quot;Breaking notice&quot; in the beginning to inform of the changes</li></ul></li><li>Move the default questions answers in <code>src/debug/Data.jl</code> to the <code>deprecated</code> dictionary.</li><li>Make sure that nothing depends on the old question</li><li>If necessary, change some <code>default</code> values to use the deprecated questions, to ensure a smooth transition.</li><li>Remove the question in the next release</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../90-contributing/">« Contributing guidelines</a><a class="docs-footer-nextpage" href="../95-reference/">Reference »</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><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 20 September 2024 15:22">Friday 20 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>