docs: add module docstrings and fill missing docstrings in imaging package#296
Merged
docs: add module docstrings and fill missing docstrings in imaging package#296
Conversation
…ckage - Add module-level docstring to fit_imaging.py describing the 6-step fitting pipeline performed by FitImaging - Add module-level docstring to simulator.py explaining the galaxy-aware simulation extension and LightProfileSNR handling - Add module-level docstring to model/analysis.py describing AnalysisImaging and its role in the model-fitting workflow - Add docstring to FitImaging.galaxies_to_inversion explaining that the dataset passed to the inversion is the profile-subtracted image Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
fit_imaging.pydescribing the 6-stepFitImagingpipelinesimulator.pyexplaining galaxy-aware simulation andLightProfileSNRhandlingmodel/analysis.pydescribingAnalysisImagingFitImaging.galaxies_to_inversionTest plan
🤖 Generated with Claude Code