What’s the recommended way to include a multi-character function or argument name in the LaTeX/math part of a docstring? \text, \mathrm, or something else?
MWE:
@doc """
Test if ``x \\le \\text{abstol}``.
"""
is_done(x, abstol) = abs(x) ≤ abstol
What’s the recommended way to include a multi-character function or argument name in the LaTeX/math part of a docstring? \text, \mathrm, or something else?
MWE:
@doc """
Test if ``x \\le \\text{abstol}``.
"""
is_done(x, abstol) = abs(x) ≤ abstol