From d01e4a7cf1c6d5424e27056511ce4c6ac592119d Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Mon, 16 Dec 2024 12:09:58 +0100 Subject: [PATCH] fix docstrings of shallow water equations (#2209) --- src/equations/shallow_water_1d.jl | 2 +- src/equations/shallow_water_2d.jl | 2 +- src/equations/shallow_water_quasi_1d.jl | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/equations/shallow_water_1d.jl b/src/equations/shallow_water_1d.jl index 29642470262..aa9b9af0092 100644 --- a/src/equations/shallow_water_1d.jl +++ b/src/equations/shallow_water_1d.jl @@ -6,7 +6,7 @@ #! format: noindent @doc raw""" - ShallowWaterEquations1D(; gravity, H0 = 0) + ShallowWaterEquations1D(; gravity_constant, H0 = 0) Shallow water equations (SWE) in one space dimension. The equations are given by ```math diff --git a/src/equations/shallow_water_2d.jl b/src/equations/shallow_water_2d.jl index 510d4560f9b..0380ef60c04 100644 --- a/src/equations/shallow_water_2d.jl +++ b/src/equations/shallow_water_2d.jl @@ -6,7 +6,7 @@ #! format: noindent @doc raw""" - ShallowWaterEquations2D(; gravity, H0 = 0) + ShallowWaterEquations2D(; gravity_constant, H0 = 0) Shallow water equations (SWE) in two space dimensions. The equations are given by ```math diff --git a/src/equations/shallow_water_quasi_1d.jl b/src/equations/shallow_water_quasi_1d.jl index eb90fb53f32..c6ab39e9635 100644 --- a/src/equations/shallow_water_quasi_1d.jl +++ b/src/equations/shallow_water_quasi_1d.jl @@ -6,7 +6,7 @@ #! format: noindent @doc raw""" - ShallowWaterEquationsQuasi1D(; gravity, H0 = 0, threshold_limiter = nothing threshold_wet = nothing) + ShallowWaterEquationsQuasi1D(; gravity_constant, H0 = 0) The quasi-1D shallow water equations (SWE). The equations are given by ```math