trixi-framework / trixi-framework/Trixi.jl

Update documentation and usage of stage callbacks (`stage_limiter!` in OrdinaryDiffEq.jl)

Open
#3,158 1 comment 0 reactions 0 assignees View on GitHub
upstream
Dominant language
Julia
Stars
731
Forks
166
Avg merge
2d 18h
Merged PRs (30d)
25

Description

Stage callbacks (`stage_limiter!` in OrdinaryDiffEq.jl) were made keyword arguments of `solve` instead of arguments to each algorithm in https://github.com/SciML/OrdinaryDiffEq.jl/pull/3835 (with deprecation path). We should consider to update our examples and documentation when this API has stabilized there.

Contributor guide

Open the contributing guide

Research direction

Review the examples and documentation that use stage_limiter! as an algorithm argument, then compare them with the stabilized solve keyword-argument API described in OrdinaryDiffEq.jl PR #3835. Update the affected usage once that API is stable, and consider the work done when the examples and documentation consistently show the new form without relying on the deprecation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.