Skip to content

docs(util): add module-level docstrings to util package#302

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

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

Conversation

@Jammy2211
Copy link
Owner

Summary

  • Added module-level docstrings to all three substantive modules in autogalaxy/util/
  • error_util.py — describes the quantile-based error estimation helpers for 1D radial profiles and 2D ellipse coordinate arrays
  • shear_field.py — documents the ShearYX2D / ShearYX2DIrregular classes, their (γ₂, γ₁) storage convention, and the AbstractShearField mixin
  • mock/mock_cosmology.py — explains that MockCosmology is a unit-test stand-in for LensingCosmology that returns hard-coded values without calling astropy

Test plan

  • No functional changes — documentation only
  • Verify module docstrings render correctly in Sphinx (make html in docs/)

🤖 Generated with Claude Code

Add module-level docstrings to error_util.py (quantile error estimation
for 1D profiles and 2D ellipses), shear_field.py (weak-lensing shear
field data structures and their convention), and mock/mock_cosmology.py
(explaining its role as a lightweight test stand-in for LensingCosmology).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit 67783ad 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