Skip to content

Commit 601b132

Browse files
d-burgclaude
andcommitted
DOCS - BUG FIX - Backtick the chi_tor unit label so Documenter stops parsing it as a link
The clarified chi_tor docstrings wrote "diffusivity [m²/s] (a viscosity ...)", which CommonMark reads as the link [m²/s](a viscosity ...). Documenter then fails the InnerLayer autodocs page with :cross_references, invalid local link/image. Backticking the unit is the convention CLAUDE.md prescribes for exactly this trap. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 76ba037 commit 601b132

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

src/InnerLayer/SLAYER/LayerInputs.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ profiles, without an intermediate file round-trip.
9191
- `chi_perp` -- perpendicular heat diffusivity [m²/s]. Scalar or a
9292
callable of `psi` (default `1.0`).
9393
- `chi_tor` -- Fitzpatrick's χ_φ: anomalous perpendicular ion MOMENTUM
94-
diffusivity [m²/s] (a viscosity entering the vorticity and parallel-flow
94+
diffusivity `[m²/s]` (a viscosity entering the vorticity and parallel-flow
9595
equations — not a heat diffusivity). Scalar or a callable of `psi`
9696
(default `1.0`).
9797
- `dr_val` -- resistive interchange index `D_R = E + F + H²`

src/InnerLayer/SLAYER/LayerParameters.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ parametrization (P_perp/P_tor/D_norm; the older magnetic/electron Prandtl
199199
- `zeff` -- effective charge
200200
- `chi_perp` -- perpendicular energy diffusivity χ⊥ [m²/s]
201201
- `chi_tor` -- Fitzpatrick's χ_φ, the anomalous perpendicular ion momentum
202-
diffusivity [m²/s] (a viscosity, not heat; TJ Layer.tex eqs. — enters the
202+
diffusivity `[m²/s]` (a viscosity, not heat; TJ Layer.tex eqs. — enters the
203203
vorticity and parallel-flow equations, τ_φ = r_s²/χ_φ)
204204
- `m`, `n` -- poloidal / toroidal mode numbers at the surface
205205
- `dr_val`, `dgeo_val` -- inputs for the critical-Δ formula

0 commit comments

Comments
 (0)