docs: fix dead internal references in script docstrings - #38
Merged
Conversation
The README half of this drift class is fixed and now gated at PR time
(PyAutoHands#213). This is the remaining surface: dead file/folder
references in scripts/**/*.py docstrings and comments, which the gate
deliberately does not cover.
Driven by `pyauto-brain hygiene refs --json`, which reported 129 findings
across 7 repos. Verified classes:
- log_likelihood_function -> likelihood_function (the scripts drop the log_)
- notation/label.yaml -> notation.yaml (config went folder -> file)
- config/generag.yaml -> config/general.yaml (autolens->autogalaxy clone
residue, here in script prose)
- autofit_workspace/*/plots -> plot (the package is singular)
- feature/pixelization/... -> features/ ; subhalo/detection -> detect
- guides/source_science -> the topic packages (source_science.py lives in
imaging/, interferometer/, group/ -- never guides/)
- preprocess / propocess -> imaging/data_preparation
- modeling/imaging/{customize,searches} -> guides/modeling/...
- imaging/advanced/database -> guides/results/database
- simulators -> simulator (singular)
- dataset directories quoted without their `dataset/` prefix -- the folder
is written by a simulator, so the fix is qualification, not a restore
Eleven needed prose rewriting rather than a re-point, because the target
does not exist in any form: autogalaxy has no CPU-fast pixelization example
(now points at the autolens one), point_source has no likelihood_function
walkthrough (points at cluster/likelihood_function, titled "Log Likelihood
Function: Cluster Point Source"), no subhalo/detect/examples folder exists,
mat_wrap.yaml was retired in favour of general.yaml, config/priors has no
`default` subfolder, and z_projects/ is not part of this workspace (the
Euclid pipeline has its own repo).
Notebooks and the navigator catalogue regenerated, since docstring text
feeds notebooks/, llms-full.txt and workspace_index.json.
Verified: hygiene refs reports 0 findings across all 7 repos (from 129),
and check_navigator.py --banners=fail passes on all 6 gated repos.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Part of PyAutoLabs/autolens_workspace#377, which tracks this sweep across all 7 repos.
Summary
The README half of this drift class is fixed and now gated at PR time (PyAutoHands#213). This is the remaining surface: dead file/folder references in
scripts/**/*.pydocstrings and comments — the same restructure debt, in prose the gate deliberately does not cover.Driven by
pyauto-brain hygiene refs --json, which reported 129 findings across 7 repos.Scripts Changed
Docstring/comment prose only — no code, no API, no behaviour. Notebooks and the navigator catalogue are regenerated, since docstring text feeds
notebooks/,llms-full.txtandworkspace_index.json.Verified re-points (113):
log_likelihood_function→likelihood_function— the scripts drop thelog_prefixnotation/label.yaml→notation.yaml— the config went from a folder to a fileconfig/generag.yaml→config/general.yaml— autolens→autogalaxy clone residue, here in script proseautofit_workspace/*/plots→plot— the package is singularfeature/pixelization/…→features/…;subhalo/detection→subhalo/detectguides/source_science→ the topic packages (source_science.pylives inimaging/,interferometer/,group/— neverguides/)preprocess/propocess→imaging/data_preparationmodeling/imaging/{customize,searches}→guides/modeling/…;imaging/advanced/database→guides/results/databasesimulators→simulator(singular)dataset/prefix — the folder is written by a simulator, so the fix is qualification, not a restoreEleven needed prose rewriting, because the target does not exist in any form:
point_sourcehas no likelihood-function walkthrough → points atcluster/likelihood_function, which is literally titled "Log Likelihood Function: Cluster Point Source"subhalo/detect/examplesfolder exists anywhere → dead sentence removedmat_wrap.yamlwas retired in favour ofgeneral.yamlconfig/priorshas nodefaultsubfolderz_projects/is not part of this workspace → the Euclid pipeline has its own repoValidation
hygiene refs: 129 → 0 findings across all 7 repos.check_navigator.py --banners=fail: PASS on all 6 gated repos.point_source/log_likelihood_function→point_source/likelihood_functionandsubhalo/detection/examples→subhalo/detect/examples, but neither target exists. Both re-fixed above.Known gap
autocti_workspacenotebooks are not regenerated.generate.pyrejects theautoctiproject — it is absent fromCOLAB_PROJECTSand from PyAutoNerves's_PROJECTSregistry. Attempting it deletes thenotebooks/tree and aborts (restored here; no damage in this branch). The 5 script fixes stand; that repo's notebooks stay as they were. Filing a follow-up to registerautocti.🤖 Generated with Claude Code