Skip to content

Commit aaab07d

Browse files
Use double backticks to prevent Documenter auto-linking
SimpleDiffEq and DASSL don't have docstrings, so Documenter's auto-linking of backticked code to cross-references fails. Using double backticks prevents auto-linking while still rendering as code. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 6e02435 commit aaab07d

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/src/api/dassl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ These methods can be used independently of the rest of DifferentialEquations.jl.
1818

1919
The following DAE solver is available:
2020

21-
- `dassl` - A native Julia implementation of the DASSL algorithm. This is an
21+
- ``dassl`` - A native Julia implementation of the DASSL algorithm. This is an
2222
adaptive-order, adaptive-stepsize backward differentiation formula (BDF)
2323
method for solving stiff systems of differential-algebraic equations.
2424

docs/src/api/simplediffeq.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ import SimpleDiffEq
1818

1919
The following ODE solvers are available:
2020

21-
- `SimpleTsit5` - A fixed timestep integrator form of Tsit5. Not compatible with events.
22-
- `SimpleATsit5` - An adaptive Tsit5 with an interpolation in its simplest form. Not compatible with events.
23-
- `GPUSimpleATsit5` - A version of `SimpleATsit5` without the integrator interface. Only allows `solve`.
24-
- `SimpleEuler` - A fixed timestep bare-bones Euler implementation with integrators.
25-
- `SimpleRK4` - A fixed timestep bare-bones RK4 implementation with integrators.
26-
- `GPUSimpleVern7` - A fully static Vern7 for specialized compilation to accelerators like GPUs and TPUs.
27-
- `GPUSimpleVern9` - A fully static Vern9 for specialized compilation to accelerators like GPUs and TPUs.
28-
- `GPUSimpleTsit5` - A fully static Tsit5 for specialized compilation to accelerators.
29-
- `GPUSimpleRK4` - A fully static RK4 for specialized compilation to accelerators.
30-
- `GPUSimpleEuler` - A fully static Euler for specialized compilation to accelerators.
31-
- `LoopEuler` - A fixed timestep bare-bones Euler. Not compatible with events or the integrator interface.
32-
- `LoopRK4` - A fixed timestep bare-bones RK4. Not compatible with events or the integrator interface.
21+
- ``SimpleTsit5`` - A fixed timestep integrator form of Tsit5. Not compatible with events.
22+
- ``SimpleATsit5`` - An adaptive Tsit5 with an interpolation in its simplest form. Not compatible with events.
23+
- ``GPUSimpleATsit5`` - A version of SimpleATsit5 without the integrator interface. Only allows `solve`.
24+
- ``SimpleEuler`` - A fixed timestep bare-bones Euler implementation with integrators.
25+
- ``SimpleRK4`` - A fixed timestep bare-bones RK4 implementation with integrators.
26+
- ``GPUSimpleVern7`` - A fully static Vern7 for specialized compilation to accelerators like GPUs and TPUs.
27+
- ``GPUSimpleVern9`` - A fully static Vern9 for specialized compilation to accelerators like GPUs and TPUs.
28+
- ``GPUSimpleTsit5`` - A fully static Tsit5 for specialized compilation to accelerators.
29+
- ``GPUSimpleRK4`` - A fully static RK4 for specialized compilation to accelerators.
30+
- ``GPUSimpleEuler`` - A fully static Euler for specialized compilation to accelerators.
31+
- ``LoopEuler`` - A fixed timestep bare-bones Euler. Not compatible with events or the integrator interface.
32+
- ``LoopRK4`` - A fixed timestep bare-bones RK4. Not compatible with events or the integrator interface.
3333

3434
## SDE Solvers
3535

3636
The following SDE solvers are available:
3737

38-
- `SimpleEM` - A fixed timestep solve method for Euler-Maruyama. Only works with non-colored Gaussian noise.
38+
- ``SimpleEM`` - A fixed timestep solve method for Euler-Maruyama. Only works with non-colored Gaussian noise.

0 commit comments

Comments
 (0)