Skip to content

docs: add module docstrings and fill missing method docstrings in operate package#295

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

docs: add module docstrings and fill missing method docstrings in operate package#295
Jammy2211 merged 1 commit intomainfrom
docs/operate

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

  • Add module-level docstring to image.py explaining the OperateImage / OperateImageList / OperateImageGalaxies mixin hierarchy
  • Add module-level docstring to lens_calc.py listing all derived lensing quantities
  • Add docstrings to OperateImage.image_2d_from and OperateImage.has (previously undocumented abstract stubs)
  • Add docstring to _blurred_image_2d_from

Test plan

  • Confirm Sphinx docs build without errors

🤖 Generated with Claude Code

…rate package

- Add module-level docstring to image.py explaining the OperateImage /
  OperateImageList / OperateImageGalaxies mixin hierarchy
- Add module-level docstring to lens_calc.py listing all the lensing
  quantities that LensCalc can derive from a deflection callable
- Add docstrings to OperateImage.image_2d_from and OperateImage.has
  (previously only raised NotImplementedError without documentation)
- Add docstring to _blurred_image_2d_from explaining its role as the
  internal PSF convolution helper

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit af9f6d2 into main Mar 12, 2026
8 checks passed
@Jammy2211 Jammy2211 deleted the docs/operate branch April 2, 2026 11:42
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