Two committed gallery `codeobj.json` files name `KernelProblem`, which no longer exists

Aperta Adatta ai principianti
  • Qualcosa non va?
#617 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Leggi docs/conf.py:222-229 e le istruzioni dell’attività docs-examples, poi esegui i due comandi indicati per plot_07_split_block e plot_05_moving_solid_guide. Riformula la docstring di Simulation.translate in src/solprop/driver/simulation.py come descritto. Il lavoro è completato quando i record rigenerati e la docstring sono stati sottoposti a commit e grep -rl KernelProblem docs/auto_* docs/introduction non trova nulla.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue priority: low
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:

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 translate docstring.
Done when

grep -rl KernelProblem docs/auto_* docs/introduction finds nothing.

Lingua principale
Python
Stelle
3
Fork
3
Merge medio
8h 28m
PR unite (30g)
176

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di LupoLab/solprop

Tutte le issue di LupoLab/solprop

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.