fix docstrings of shallow water equations (trixi-framework#2209)

DanielDoehring · Dec 16, 2024 · d01e4a7 · d01e4a7
1 parent 30c787d
commit d01e4a7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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