Update comments for some DGSEM APIs (#2238)

* Update * Add
trixi-framework · Jan 17, 2025 · fdd22a8 · fdd22a8
1 parent 9893b73
commit fdd22a8
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/solvers/dgsem/dgsem.jl b/src/solvers/dgsem/dgsem.jl
@@ -22,7 +22,7 @@ Create a discontinuous Galerkin spectral element method (DGSEM) using a
 """
 const DGSEM = DG{Basis} where {Basis <: LobattoLegendreBasis}
 
-# TODO: Deprecated in v0.3 (no longer documented)
+# This API is no longer documented, and we recommend avoiding its public use.
 function DGSEM(basis::LobattoLegendreBasis,
                surface_flux = flux_central,
                volume_integral = VolumeIntegralWeakForm(),
@@ -32,7 +32,7 @@ function DGSEM(basis::LobattoLegendreBasis,
               typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
 end
 
-# TODO: Deprecated in v0.3 (no longer documented)
+# This API is no longer documented, and we recommend avoiding its public use.
 function DGSEM(basis::LobattoLegendreBasis,
                surface_integral::AbstractSurfaceIntegral,
                volume_integral = VolumeIntegralWeakForm(),
@@ -41,7 +41,7 @@ function DGSEM(basis::LobattoLegendreBasis,
               typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
 end
 
-# TODO: Deprecated in v0.3 (no longer documented)
+# This API is no longer documented, and we recommend avoiding its public use.
 function DGSEM(RealT, polydeg::Integer,
                surface_flux = flux_central,
                volume_integral = VolumeIntegralWeakForm(),
@@ -51,6 +51,7 @@ function DGSEM(RealT, polydeg::Integer,
     return DGSEM(basis, surface_flux, volume_integral, mortar)
 end
 
+# This API is no longer documented, and we recommend avoiding its public use.
 function DGSEM(polydeg, surface_flux = flux_central,
                volume_integral = VolumeIntegralWeakForm())
     DGSEM(Float64, polydeg, surface_flux, volume_integral)