build based on 96bd36d

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-31T16:14:22","documenter_version":"1.14.1"}}
+{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-08-31T16:30:36","documenter_version":"1.14.1"}}

dev/CHANGELOG/index.html

@@ -98,4 +98,4 @@
   ````</code></pre></li></ul><h3 id="Constants"><a class="docs-heading-anchor" href="#Constants">Constants</a><a id="Constants-1"></a><a class="docs-heading-anchor-permalink" href="#Constants" title="Permalink"></a></h3><ul><li><p><strong>Format:</strong> Use a single-line docstring with double quotes (<code>&quot;...&quot;</code>). Include a brief description, the symbol of the constant if standard (e.g., <code>μ₀</code>), its value, and its units using the <code>\\[unit\\]</code> format.</p><pre><code class="nohighlight hljs">  ```julia
   &quot;Magnetic constant (vacuum permeability), μ₀ = 4π * 1e-7 \\[H/m\\]].&quot;
   const μ₀ = 4π * 1e-7
-  ```</code></pre></li></ul><h2 id="Common-mistakes-to-avoid"><a class="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><a id="Common-mistakes-to-avoid-1"></a><a class="docs-heading-anchor-permalink" href="#Common-mistakes-to-avoid" title="Permalink"></a></h2><p>Double-check the docstrings to avoid these common errors:</p><ul><li><strong>Missing <code>@doc</code> for constructors:</strong> ALL constructors require the <code>@doc</code> macro before their definition.</li><li><strong>Incorrect struct field docstrings:</strong> Use single-line <code>&quot;...&quot;</code> <em>above</em> the field, not block <code>&quot;&quot;&quot;...&quot;&quot;&quot;</code> quotes or inline <code>#</code> comments.</li><li><strong>Incorrect section order:</strong> Follow the specified order for function docstring sections precisely.</li><li><strong>Hard-coding function names in examples:</strong> Always use <code>$(FUNCTIONNAME)</code>.</li><li><strong>Incorrect unit formatting:</strong> Ensure <code>\\[unit\\]</code> syntax is used everywhere except comments within <code>Examples</code> blocks (<code>[unit]</code>). Double-check escaping (<code>\\</code>) for LaTeX.</li><li><strong>Adding math formulas to non-<code>calc_</code> functions:</strong> Math blocks are <em>only</em> for functions prefixed with <code>calc_</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../validation/">« Validation module</a><a class="docs-footer-nextpage" href="../TODO/">TODO »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/Electa-Git/LineCableModels.jl">LineCableModels.jl</a> v0.1.1-DEV supported by the Etch Competence Hub of EnergyVille, financed by the Flemish Government.</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.14.1 on <span class="colophon-date" title="Sunday 31 August 2025 16:07">Sunday 31 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  ```</code></pre></li></ul><h2 id="Common-mistakes-to-avoid"><a class="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><a id="Common-mistakes-to-avoid-1"></a><a class="docs-heading-anchor-permalink" href="#Common-mistakes-to-avoid" title="Permalink"></a></h2><p>Double-check the docstrings to avoid these common errors:</p><ul><li><strong>Missing <code>@doc</code> for constructors:</strong> ALL constructors require the <code>@doc</code> macro before their definition.</li><li><strong>Incorrect struct field docstrings:</strong> Use single-line <code>&quot;...&quot;</code> <em>above</em> the field, not block <code>&quot;&quot;&quot;...&quot;&quot;&quot;</code> quotes or inline <code>#</code> comments.</li><li><strong>Incorrect section order:</strong> Follow the specified order for function docstring sections precisely.</li><li><strong>Hard-coding function names in examples:</strong> Always use <code>$(FUNCTIONNAME)</code>.</li><li><strong>Incorrect unit formatting:</strong> Ensure <code>\\[unit\\]</code> syntax is used everywhere except comments within <code>Examples</code> blocks (<code>[unit]</code>). Double-check escaping (<code>\\</code>) for LaTeX.</li><li><strong>Adding math formulas to non-<code>calc_</code> functions:</strong> Math blocks are <em>only</em> for functions prefixed with <code>calc_</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../validation/">« Validation module</a><a class="docs-footer-nextpage" href="../TODO/">TODO »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/Electa-Git/LineCableModels.jl">LineCableModels.jl</a> v0.1.1-DEV supported by the Etch Competence Hub of EnergyVille, financed by the Flemish Government.</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.14.1 on <span class="colophon-date" title="Sunday 31 August 2025 16:23">Sunday 31 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>