Format plot title in docs (#268)

* Format plot title in docs

* fix typo

* add Printf to docs/Project.toml

Author: JoshuaLampert

docs/Project.toml

@@ -3,6 +3,7 @@ Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284"
@@ -12,6 +13,7 @@ Changelog = "1"
 Documenter = "1"
 OrdinaryDiffEqTsit5 = "1"
 Plots = "1.9"
+Printf = "1"
 SparseArrays = "1"
 SummationByPartsOperators = "0.5.41"
 TrixiBase = "0.1.1"

docs/src/basic_example.md

@@ -118,9 +118,9 @@ After running the simulation, the results can be visualized using [Plots.jl](htt
 plot the solution at the final time by calling `plot` on a `Pair` of the `Semidiscretization` and the corresponding `ODESolution` `sol`. The result is depicted in the following picture.
 
 ```@example overview
-using Plots
-# default( grid=true, box=:on, dpi=100, titlefont=font(16), linewidth=3, gridlinewidth=2, markersize=4, markerstrokewidth=2, xtickfontsize=14, ytickfontsize=14, xguidefontsize=16, yguidefontsize=16, ztickfontsize=14, zguidefontsize=16, legendfontsize=14) # hide
-plot(semi => sol)
+using Plots, Printf
+# default(grid=true, box=:on, dpi=100, titlefont=font(16), linewidth=3, gridlinewidth=2, markersize=4, markerstrokewidth=2, xtickfontsize=14, ytickfontsize=14, xguidefontsize=16, yguidefontsize=16, ztickfontsize=14, zguidefontsize=16, legendfontsize=14) # hide
+plot(semi => sol, plot_title = @sprintf "BBM-BBM equations at t = %.2f" last(tspan))
 savefig("shoaling_solution.png") # hide
 nothing # hide
 ```
@@ -135,7 +135,8 @@ Plotting an animation over time can, e.g., be done by the following command, whi
 
 ```@example overview
 anim = @animate for step in 1:length(sol.u)
-    plot(semi => sol, plot_initial = true, conversion = waterheight_total, step = step, xlims = (-50, 20), ylims = (-0.8, 0.1))
+    plot(semi => sol, plot_initial = true, conversion = waterheight_total, step = step, xlims = (-50, 20), ylims = (-0.8, 0.1),
+         plot_title = @sprintf "BBM-BBM equations at t = %.2f" sol.t[step])
 end
 gif(anim, "shoaling_solution.gif", fps = 25)
 nothing # hide