trixi-framework / trixi-framework/TrixiParticles.jl
Arguments for the `SteadyStateReachedCallback` are confusing
Open
Nobody has claimed this yet.
discussion
- Dominant language
- Julia
- Stars
- 83
- Forks
- 24
- Avg merge
- 8d 18h
- Merged PRs (30d)
- 3
Description
I find it very confusing that there are options interval and interval_size. The latter should be renamed. Maybe something like stencil or stencil_interval would be better?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names SteadyStateReachedCallback and its interval and interval_size options but does not identify files or tests. Locate the callback entry point and all uses of interval_size, then determine the intended replacement name; done means the chosen name is applied consistently without leaving the confusing option behind.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100