Skip to content

docs(lens): add module-level docstrings to lens package#393

Merged
Jammy2211 merged 1 commit intomainfrom
docs/lens
Mar 12, 2026
Merged

docs(lens): add module-level docstrings to lens package#393
Jammy2211 merged 1 commit intomainfrom
docs/lens

Conversation

@Jammy2211
Copy link
Owner

Summary

Added module-level docstrings to all five substantive modules in autolens/lens/:

  • tracer.py — core Tracer class: multi-plane ray tracing, lensed images, convergence/shear/magnification maps, critical curves, lens modeling role
  • tracer_util.py — utility functions for plane redshift derivation and position propagation
  • to_inversion.pyTracerToInversion: bridges Tracer to autoarray's linear algebra inversion
  • sensitivity.pySubhaloSensitivityResult: sensitivity mapping for dark-matter subhalo detectability
  • subhalo.pySubhaloGridSearchResult: grid-search detection pipeline

Test plan

  • No functional changes — documentation only
  • Verify module docstrings render in Sphinx

🤖 Generated with Claude Code

Add module-level docstrings to all five substantive modules in
autolens/lens/:

- tracer.py: core Tracer class — multi-plane ray tracing, lensed images,
  convergence/shear/magnification maps, critical curves, lens modeling role
- tracer_util.py: plane redshift derivation and position propagation utilities
- to_inversion.py: TracerToInversion — bridges Tracer to autoarray's linear
  algebra inversion for linear light profiles and pixelizations
- sensitivity.py: SubhaloSensitivityResult — sensitivity mapping workflow
  for dark-matter subhalo detectability
- subhalo.py: SubhaloGridSearchResult — grid-search detection pipeline for
  dark-matter subhalos

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit b5d9eb3 into main Mar 12, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant