build based on b2b280d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-08T21:29:01","documenter_version":"1.1.0"}}
+{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-08T22:48:08","documenter_version":"1.1.0"}}

dev/developers/contributing/index.html

@@ -9,9 +9,9 @@
 <span class="sgr32"><span class="sgr1">     Deleted</span></span> no artifacts, repos, packages or scratchspaces</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.develop(&quot;MillerIndices&quot;)</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1">     Cloning</span></span> git-repo `https://github.com/MineralsCloud/MillerIndices.jl.git`
 <span class="sgr32"><span class="sgr1">   Resolving</span></span> package versions...
 <span class="sgr32"><span class="sgr1">    Updating</span></span> `~/work/MillerIndices.jl/MillerIndices.jl/docs/Project.toml`
-  <span class="sgr90">[f41335bc] </span><span class="sgr93">~ MillerIndices v0.2.0 `~/work/MillerIndices.jl/MillerIndices.jl` ⇒ v0.3.0 `~/.julia/dev/MillerIndices`</span>
+  <span class="sgr90">[f41335bc] </span><span class="sgr93">~ MillerIndices v0.3.0 `~/work/MillerIndices.jl/MillerIndices.jl` ⇒ v0.3.0 `~/.julia/dev/MillerIndices`</span>
 <span class="sgr32"><span class="sgr1">    Updating</span></span> `~/work/MillerIndices.jl/MillerIndices.jl/docs/Manifest.toml`
-  <span class="sgr90">[f41335bc] </span><span class="sgr93">~ MillerIndices v0.2.0 `~/work/MillerIndices.jl/MillerIndices.jl` ⇒ v0.3.0 `~/.julia/dev/MillerIndices`</span></code></pre><p>Then the package will be cloned to your local machine. On *nix systems, the default path is <code>~/.julia/dev/MillerIndices</code> unless you modify the <a href="http://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_DEPOT_PATH-1"><code>JULIA_DEPOT_PATH</code></a> environment variable. If you&#39;re on Windows, this will be <code>C:\\Users\\&lt;my_name&gt;\\.julia\\dev\\MillerIndices</code>. In the following text, we will call it <code>PKGROOT</code>.</p><p>Go to <code>PKGROOT</code>, start a new Julia session, and run</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.instantiate()</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1">Precompiling</span></span> project...
+  <span class="sgr90">[f41335bc] </span><span class="sgr93">~ MillerIndices v0.3.0 `~/work/MillerIndices.jl/MillerIndices.jl` ⇒ v0.3.0 `~/.julia/dev/MillerIndices`</span></code></pre><p>Then the package will be cloned to your local machine. On *nix systems, the default path is <code>~/.julia/dev/MillerIndices</code> unless you modify the <a href="http://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_DEPOT_PATH-1"><code>JULIA_DEPOT_PATH</code></a> environment variable. If you&#39;re on Windows, this will be <code>C:\\Users\\&lt;my_name&gt;\\.julia\\dev\\MillerIndices</code>. In the following text, we will call it <code>PKGROOT</code>.</p><p>Go to <code>PKGROOT</code>, start a new Julia session, and run</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.instantiate()</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1">Precompiling</span></span> project...
 <span class="sgr33">  ✓ </span>MillerIndices
   1 dependency successfully precompiled in 1 seconds. 27 already precompiled.
   <span class="sgr33">1</span> dependency precompiled but a different version is currently loaded. Restart julia to access the new version</code></pre><p>to instantiate the project.</p><h3 id="Step-4:-checkout-a-new-branch"><a class="docs-heading-anchor" href="#Step-4:-checkout-a-new-branch">Step 4: checkout a new branch</a><a id="Step-4:-checkout-a-new-branch-1"></a><a class="docs-heading-anchor-permalink" href="#Step-4:-checkout-a-new-branch" title="Permalink"></a></h3><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>In the following, replace any instance of <code>GITHUB_ACCOUNT</code> with your GitHub username.</p></div></div><p>The next step is to check out a development branch. In a terminal (or command prompt on Windows), run:</p><pre><code class="language-bash hljs">$ cd ~/.julia/dev/MillerIndices
@@ -46,4 +46,4 @@
 
 $ git checkout main
 
-$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to MillerIndices!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../lib/internals/abstract/">« Abstract types</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</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.1.0 on <span class="colophon-date" title="Sunday 8 October 2023 21:29">Sunday 8 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to MillerIndices!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../lib/internals/abstract/">« Abstract types</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</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.1.0 on <span class="colophon-date" title="Sunday 8 October 2023 22:48">Sunday 8 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/developers/style-guide/index.html

@@ -5,4 +5,4 @@
 
 julia> using JuliaFormatter: format
 
-julia&gt; format(&quot;docs&quot;); format(&quot;src&quot;); format(&quot;test&quot;)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to MillerIndices have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">Visual Studio Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. For the time being, we do not recommend using editors other than Visual Studio Code to edit your code.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</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.1.0 on <span class="colophon-date" title="Sunday 8 October 2023 21:29">Sunday 8 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; format(&quot;docs&quot;); format(&quot;src&quot;); format(&quot;test&quot;)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to MillerIndices have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">Visual Studio Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. For the time being, we do not recommend using editors other than Visual Studio Code to edit your code.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</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.1.0 on <span class="colophon-date" title="Sunday 8 October 2023 22:48">Sunday 8 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>