Skip to content

Commit fdd22a8

Browse files
authored
Update comments for some DGSEM APIs (#2238)
* Update * Add
1 parent 9893b73 commit fdd22a8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/solvers/dgsem/dgsem.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Create a discontinuous Galerkin spectral element method (DGSEM) using a
2222
"""
2323
const DGSEM = DG{Basis} where {Basis <: LobattoLegendreBasis}
2424

25-
# TODO: Deprecated in v0.3 (no longer documented)
25+
# This API is no longer documented, and we recommend avoiding its public use.
2626
function DGSEM(basis::LobattoLegendreBasis,
2727
surface_flux = flux_central,
2828
volume_integral = VolumeIntegralWeakForm(),
@@ -32,7 +32,7 @@ function DGSEM(basis::LobattoLegendreBasis,
3232
typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
3333
end
3434

35-
# TODO: Deprecated in v0.3 (no longer documented)
35+
# This API is no longer documented, and we recommend avoiding its public use.
3636
function DGSEM(basis::LobattoLegendreBasis,
3737
surface_integral::AbstractSurfaceIntegral,
3838
volume_integral = VolumeIntegralWeakForm(),
@@ -41,7 +41,7 @@ function DGSEM(basis::LobattoLegendreBasis,
4141
typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
4242
end
4343

44-
# TODO: Deprecated in v0.3 (no longer documented)
44+
# This API is no longer documented, and we recommend avoiding its public use.
4545
function DGSEM(RealT, polydeg::Integer,
4646
surface_flux = flux_central,
4747
volume_integral = VolumeIntegralWeakForm(),
@@ -51,6 +51,7 @@ function DGSEM(RealT, polydeg::Integer,
5151
return DGSEM(basis, surface_flux, volume_integral, mortar)
5252
end
5353

54+
# This API is no longer documented, and we recommend avoiding its public use.
5455
function DGSEM(polydeg, surface_flux = flux_central,
5556
volume_integral = VolumeIntegralWeakForm())
5657
DGSEM(Float64, polydeg, surface_flux, volume_integral)

0 commit comments

Comments
 (0)