Two committed gallery `codeobj.json` files name `KernelProblem`, which no longer exists
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Read docs/conf.py:222-229 and the docs-examples task instructions, then run the two named commands for plot_07_split_block and plot_05_moving_solid_guide. Reword the Simulation.translate docstring in src/solprop/driver/simulation.py as described. Done when the regenerated records and docstring are committed and grep -rl KernelProblem docs/auto_* docs/introduction finds nothing.
Written by the indexing model from the issue text.
Description
What happens
KernelProblem was renamed PropagationProblem with no alias (8c8caed0, on main).
Two committed sphinx-gallery records still list KernelProblem as the type of problem,
under solprop.translate.problem, solprop.translate and solprop:
docs/auto_tutorials/waveguides/plot_07_split_block.codeobj.json(theproblem
entries), fromproblem = turned.translate()at
plot_07_split_block.py#L148;docs/auto_examples/waveguides/plot_05_moving_solid_guide.codeobj.json, from
plot_05_moving_solid_guide.py#L299.
Both files were last written by c8e5a52d, before the rename, and are the same on main.
No other committed codeobj.json names KernelProblem. I scanned every entry under
docs/ whose module starts solprop. No other renamed name turned up, only the
re-export guesses that sphinx-gallery always makes.
Why it matters
These records drive the gallery's links and backreferences. A link to a type that no
longer exists goes nowhere, and a search of the docs for the old name turns up
generated output that looks current.
Why regenerating fixes it, and how
The scripts' text did not change, so their .md5 files are current and
poe docs-examples (the default stale mode) will not run them. Run each by name, which
forces a re-run (docs/conf.py:222-229):
uv run poe docs-examples plot_07_split_block
uv run poe docs-examples plot_05_moving_solid_guide
Simulation.translate() is annotated -> PropagationProblem
(src/solprop/driver/simulation.py:2510), so the records will name the new type. Regenerating may also refresh figures and printed output at rounding level.
Also: the Simulation.translate docstring still says "Assemble the kernel problem"
(simulation.py:2511).
To do
- Regenerate both scripts by name, and commit their output.
- Reword the
translatedocstring.
Done when
grep -rl KernelProblem docs/auto_* docs/introduction finds nothing.
- Dominant language
- Python
- Stars
- 3
- Forks
- 3
- Avg merge
- 8h 28m
- Merged PRs (30d)
- 176
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from LupoLab/solprop
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: medium
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: low
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation priority: high
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area: native priority: low testing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
Similar issues
-
bug triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
mealie-recipes/mealie#9117 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
freelawproject/courtlistener#8406 ·
Maintainers usually reply within 2 days
-
good first issue help wanted level 1 wocs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
GianlucaBave/murmury#49 ·
Maintainers usually reply within 1 day
-
regression skipped skipped_bmg
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
intel/torch-xpu-ops#6142 · 1 comment ·
Maintainers usually reply within 2 days
-
good first issue help wanted python up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 85/100
andrewsiah/agentswarm-data-tasks#122 ·
Maintainers usually reply within 1 day