Skip to content

docs: fix cluster dataset path prose + document simulator folder - #72

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/folder-list-ref-drift-sweep
Aug 20, 2026
Merged

docs: fix cluster dataset path prose + document simulator folder#72
Jammy2211 merged 1 commit into
mainfrom
feature/folder-list-ref-drift-sweep

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Two fixes from the 2026-08-19 hygiene refs scan: (1) scripts/simulator/cluster.py told the reader the dataset is output to howtolens/dataset/cluster/simple, but the script writes Path("dataset", "cluster", "simple") and sibling simulators (group.py, interferometer.py, weak_lensing.py) all use the bare repo-relative form — re-pointed both prose lines to dataset/cluster/simple; (2) scripts/README.md's folder list never named simulator/ — added the entry. Regenerated notebook twins committed per convention. Prose-only — no code cells changed.

Note: the scan's five weak/*.py findings in tutorial_6_weak_lensing.py were adjudicated false positives (valid references into autolens_workspace/scripts/weak/, which the surrounding prose names explicitly) and are deliberately untouched.

Part of the folder-list ref-drift sweep: PyAutoLabs/autogalaxy_workspace#215.

Scripts Changed

  • scripts/simulator/cluster.py — dataset-path prose re-point ×2 (docstring only)
  • scripts/README.md — added simulator/ to the Folders list
  • notebooks/simulator/cluster.ipynb, notebooks/README.md — regenerated twins

Test Plan

  • Diff touches only docstring/README prose (no code lines)
  • python -m py_compile on scripts/simulator/cluster.py
  • Hygiene refs re-scan of the branch: both real findings cleared

Generated by the PyAutoLabs agent workflow.

…er to README

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QZgtrvhRLwTk17ywRJAFRk
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Aug 20, 2026
@Jammy2211
Jammy2211 merged commit 503291c into main Aug 20, 2026
7 checks passed
@Jammy2211
Jammy2211 deleted the feature/folder-list-ref-drift-sweep branch August 20, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant