use DocumenterCodeBlocks.jl

[ranocha]

No description provided.

[JoshuaLampert]

Thanks!

[JoshuaLampert]

I noticed https://numericalmathematics.github.io/DispersiveShallowWater.jl/previews/PR313/basic_example/#overview-plain-program does not render nicely. Can you try a small julia instead of capitalized Julia here to see if this fixes it, please?

[JoshuaLampert]

There are also these two warnings that are maybe worth fixing: https://github.com/NumericalMathematics/DispersiveShallowWater.jl/actions/runs/30890665176/job/91931706907?pr=313#step:7:20.

[ranocha]

I fixed one of the warnings. The other one appears to refer to

DispersiveShallowWater.jl/src/solver.jl

Lines 8 to 12 in 9354d1c

	"""
	Solver
	A `struct` that holds the summation-by-parts (SBP) operators that are used for the spatial discretization.
	"""

which has definitely a first sentence with less than 200 characters, so I don't understand the issue.

[JoshuaLampert]

Thanks! Maybe it refers to

DispersiveShallowWater.jl/src/solver.jl

Lines 76 to 86 in 9354d1c

	"""
	Solver(D1, D2 = nothing, D3 = nothing)
	Create a solver, where `D1` is an `AbstractDerivativeOperator`
	from [SummationByPartsOperators.jl](https://github.com/ranocha/SummationByPartsOperators.jl)
	of first `derivative_order`, `D2` is an `AbstractDerivativeOperator`
	of second `derivative_order` or an `AbstractMatrix`, and `D3` is an `AbstractDerivativeOperator`
	of third `derivative_order` or an `AbstractMatrix`. `D2` and `D3` can also be `nothing`
	if that derivative is not used by the discretization.
	All given summation-by-parts operators should be associated with the same grid.
	"""

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[github-actions]

Benchmark Results (Julia v1.10)

Time benchmarks

	main	168270c...	main / 168270c...
bbm_1d/bbm_1d_basic.jl - rhs!:	13.8 ± 0.31 μs	15 ± 0.36 μs	0.917 ± 0.03
bbm_1d/bbm_1d_fourier.jl - rhs!:	0.216 ± 0.011 ms	0.528 ± 0.011 ms	0.409 ± 0.022
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	0.0795 ± 0.00028 ms	0.0794 ± 0.00036 ms	1 ± 0.0057
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	0.0345 ± 0.003 ms	0.035 ± 0.00056 ms	0.985 ± 0.087
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	27.7 ± 3 μs	26.9 ± 0.4 μs	1.03 ± 0.11
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	0.0493 ± 0.003 ms	0.0487 ± 0.00061 ms	1.01 ± 0.062
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	4.14 ± 0.03 μs	4.13 ± 0.03 μs	1 ± 0.01
kdv_1d/kdv_1d_basic.jl - rhs!:	1.38 ± 0.01 μs	1.36 ± 0.02 μs	1.01 ± 0.017
kdv_1d/kdv_1d_implicit.jl - rhs!:	1.34 ± 0.011 μs	1.34 ± 0.011 μs	1 ± 0.012
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.204 ± 0.011 ms	0.199 ± 0.0095 ms	1.02 ± 0.073
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.147 ± 0.0048 ms	0.15 ± 0.0043 ms	0.98 ± 0.043
time_to_load	2.48 ± 0.037 s	2.47 ± 0.012 s	1.01 ± 0.016

Memory benchmarks

	main	168270c...	main / 168270c...
bbm_1d/bbm_1d_basic.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_1d/bbm_1d_fourier.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	5 allocs: 1.17 kB	5 allocs: 1.17 kB	1
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	10 allocs: 8.62 kB	10 allocs: 8.62 kB	1
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_basic.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_implicit.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.075 k allocs: 0.66 MB	0.075 k allocs: 0.66 MB	1
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.042 k allocs: 0.315 MB	0.042 k allocs: 0.315 MB	1
time_to_load	0.153 k allocs: 14.5 kB	0.153 k allocs: 14.5 kB	1

[JoshuaLampert]

Thanks!