Skip to content

Commit cc6ad45

Browse files
committed
Added plot as example for using the package
1 parent 465c61e commit cc6ad45

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ A Julia package for approximating the inverse of the Langevin function, ℒ.
1010
\mathcal{L}(x) = \coth(x) - \frac{1}{x}
1111
```
1212

13-
```@eval
13+
```@example
1414
using CairoMakie
1515
using InteractiveUtils
1616
using InverseLangevinApproximations
17-
using Markdown
17+
using Markdown # hide
1818
L(x) = x==zero(x) ? 0 : coth(x) - 1/x
1919
x_true = range(0.0, 10.0, length = 101)
2020
y = L.(x_true)
@@ -28,6 +28,6 @@ for f in fs
2828
lines!(ax, y, rel_error, label = string(f))
2929
end
3030
axislegend(position = :lt)
31-
save("example.png", f)
32-
Markdown.parse("![example](example.png)")
31+
save("example.png", f) # hide
32+
Markdown.parse("![example](example.png)") # hide
3333
```

0 commit comments

Comments
 (0)