TYPEDFIELDS -> TYPEDSIGNATURES

SpeedyWeather · Sep 7, 2023 · 4c96496 · 4c96496
1 parent 0332493
commit 4c96496
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/dynamics/initial_conditions.jl b/src/dynamics/initial_conditions.jl
@@ -508,10 +508,11 @@ Base.@kwdef struct RandomWaves <: InitialConditions
     lmax::Int64 = 20        # maximum wavenumber
 end
 
-"""Random initial conditions for the interface displacement η
+"""
+$(TYPEDSIGNATURES)
+Random initial conditions for the interface displacement η
 in the shallow water equations. The flow (u,v) is zero initially.
-This kicks off gravity waves that will interact with orography.
-$(TYPEDFIELDS)"""
+This kicks off gravity waves that will interact with orography."""
 function initial_conditions!(   progn::PrognosticVariables{NF},
                                 initial_conditions::RandomWaves,
                                 model::ShallowWater) where NF