docs: fix dead internal references (hygiene refs tier) - #56
Merged
Conversation
The hygiene `refs` tier found 18 dead internal references in this
tutorial series' prose — sibling-workspace paths that moved, plus a few
references that were copied in unqualified from another repo.
- `simulators/start_here.ipynb` (x5) ->
`autolens_workspace/*/imaging/simulator.ipynb`, the script literally
titled "Simulator: Start Here" (this repo's folder is `simulator/` and
has no start_here of its own)
- `autolens_workspace/*/guides/over_sampling.ipynb` ->
`guides/advanced/over_sampling.ipynb`
- `imaging/log_likelihood_function/parametric.ipynb` ->
`imaging/likelihood_function.ipynb`
- `imaging/log_likelihood_function/inversion.ipynb` ->
`imaging/features/pixelization/likelihood_function.ipynb`
- `modeling/features/multi_gaussian_expansion.py` ->
`imaging/features/multi_gaussian_expansion/modeling.py`
- `modeling/features/shapelets.py` ->
`imaging/features/advanced/shapelets/modeling.py`
- `imaging/features/pixelizations/modeling.py` -> `pixelization/` (singular)
- `notebooks/modeling/features/no_lens_light.ipynb` ->
`notebooks/imaging/features/no_lens_light/modeling.ipynb`
- `howtolens/chapter_optional/tutorial_searches.ipynb` -> the repo-local
`chapter_optional/tutorial_searches.ipynb`
- the two unqualified `imaging/features/pixelization/{modeling,fit}.py`
references in the no-lens-light simulator name the autolens_workspace
scripts that actually consume the `mask_extra_galaxies.fits` it writes
- tutorial 2's "run as standalone scripts" note pointed at HowToGalaxy
paths under autolens_workspace; it now mirrors HowToGalaxy's own
corrected wording and names this repo's chapter 2 script
The two remaining `autolens_workspace/dataset/imaging/howtolens/`
references are left as-is: that folder is written at runtime by
`tutorial_6_data.py`, so its absence from a checkout proves nothing.
Notebooks and the navigator catalogue regenerated.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PzN9PZfG5zXMVku8ckSqkC
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the hygiene
refstier findings (PyAutoBrain#165): 18 → 2. Notable: thesimulators/start_here.ipynbboilerplate (×5) resolves to autolens_workspace'simaging/simulator(literally titled "Simulator: Start Here" — this repo's folder issimulator/with no start_here);tutorial_2_practicalities.pywas pointing readers at HowToGalaxy paths nested under autolens_workspace (copy-paste from the galaxy series) and now mirrors the corrected wording with this repo's own chapter-2 script; the two unqualified pixelization refs were traced via theirmask_extra_galaxies.fitsconsumers and repo-qualified. The 2 residuals are the runtime-writtenautolens_workspace/dataset/imaging/howtolens/path — scanner false positive being fixed tier-side. 12 scripts + regenerated notebooks + catalogue.Generated by Claude Code