Skip to content

Commit

Permalink
fix some typos in docstrings of flux splittings (#1550)
Browse files Browse the repository at this point in the history
  • Loading branch information
ranocha authored Jun 26, 2023
1 parent b7be585 commit 87a1693
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions src/equations/compressible_euler_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ Splitting of the compressible Euler flux of Steger and Warming.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down Expand Up @@ -462,7 +462,7 @@ it proved the most robust in practice.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down Expand Up @@ -555,7 +555,7 @@ are to handle flows at the low Mach number limit.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down
6 changes: 3 additions & 3 deletions src/equations/compressible_euler_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ Splitting of the compressible Euler flux of Steger and Warming.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down Expand Up @@ -826,7 +826,7 @@ it proved the most robust in practice.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down Expand Up @@ -924,7 +924,7 @@ to Burgers' equation.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down
2 changes: 1 addition & 1 deletion src/equations/compressible_euler_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ Splitting of the compressible Euler flux of Steger and Warming.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down
2 changes: 1 addition & 1 deletion src/equations/inviscid_burgers_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ and `f⁻ = 0.5 (f - λ u)` where `λ = abs(u)`.
Returns a tuple of the fluxes "minus" (associated with waves going into the
negative axis direction) and "plus" (associated with waves going into the
positive axis direction). If only one of the fluxes is required, use the
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}`.
function signature with argument `which` set to `Val{:minus}()` or `Val{:plus}()`.
!!! warning "Experimental implementation (upwind SBP)"
This is an experimental feature and may change in future releases.
Expand Down

0 comments on commit 87a1693

Please sign in to comment.