Skip to content

docs(aggregator): add module-level docstrings to aggregator package#301

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

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

Conversation

@Jammy2211
Copy link
Owner

Summary

  • Added module-level docstrings to all ten modules in autogalaxy/aggregator/
  • Each docstring explains the module's purpose, the two public objects it exposes (a free helper function and an Agg class), and how they fit into the broader PyAutoFit database/aggregator workflow
  • Files covered: agg_util.py, galaxies.py, dataset_model.py, imaging/imaging.py, imaging/fit_imaging.py, interferometer/interferometer.py, interferometer/fit_interferometer.py, ellipse/ellipses.py, ellipse/fit_ellipse.py, ellipse/multipoles.py

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 all ten aggregator modules explaining the
purpose of each module, the two public objects it exposes (a free helper
function and an Agg class), and how they relate to the broader PyAutoFit
database / aggregator workflow.

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