docs(analysis): add module-level docstrings to analysis package#398
Merged
docs(analysis): add module-level docstrings to analysis package#398
Conversation
Add module-level docstrings to five modules in autolens/analysis/: - analysis/dataset.py: AnalysisDataset abstract base (shared imaging + interferometer base, positions likelihood, adapt images) - analysis/lens.py: AnalysisLens mixin (tracer construction, position penalty, use_jax flag) - positions.py: PositionsLH source-plane position penalty prior - result.py: Result / ResultDataset classes (best-fit tracer, source centre, image-plane multiple images) - model_util.py: convenience model construction utilities for workspace scripts 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
Added module-level docstrings to five modules in
autolens/analysis/:analysis/dataset.py—AnalysisDataset: abstract base combining dataset-level machinery with lensing-specific logicanalysis/lens.py—AnalysisLens: mixin for tracer construction, position penalty, JAX flagpositions.py—PositionsLH: source-plane position penalty priorresult.py—Result/ResultDataset: best-fit tracer, source centre, image-plane multiple imagesmodel_util.py— convenience model construction utilities for workspace scriptsTest plan
🤖 Generated with Claude Code