You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev/docstrings/index.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -98,4 +98,4 @@
98
98
````</code></pre></li></ul><h3id="Constants"><aclass="docs-heading-anchor" href="#Constants">Constants</a><aid="Constants-1"></a><aclass="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>"..."</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><codeclass="nohighlight hljs"> ```julia
```</code></pre></li></ul><h2id="Common-mistakes-to-avoid"><aclass="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><aid="Common-mistakes-to-avoid-1"></a><aclass="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>"..."</code><em>above</em> the field, not block <code>"""..."""</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><navclass="docs-footer"><aclass="docs-footer-prevpage" href="../validation/">« Validation module</a><aclass="docs-footer-nextpage" href="../TODO/">TODO »</a><divclass="flexbox-break"></div><pclass="footer-message"><ahref="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><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.1 on <spanclass="colophon-date" title="Monday 24 November 2025 19:16">Monday 24 November 2025</span>. Using Julia version 1.12.2.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
101
+
```</code></pre></li></ul><h2id="Common-mistakes-to-avoid"><aclass="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><aid="Common-mistakes-to-avoid-1"></a><aclass="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>"..."</code><em>above</em> the field, not block <code>"""..."""</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><navclass="docs-footer"><aclass="docs-footer-prevpage" href="../validation/">« Validation module</a><aclass="docs-footer-nextpage" href="../TODO/">TODO »</a><divclass="flexbox-break"></div><pclass="footer-message"><ahref="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><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <spanclass="colophon-date" title="Saturday 21 February 2026 17:52">Saturday 21 February 2026</span>. Using Julia version 1.12.5.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
0 commit comments