docs(point): add module-level docstrings to point package#397
Merged
Conversation
Add module-level docstrings to twelve modules in autolens/point/: - dataset.py: PointDataset and PointDict data structures - solver/point_solver.py: triangle-tiling image-position solver - solver/shape_solver.py: abstract triangle solver and ShapeSolver - fit/abstract.py: AbstractFitPoint shared base class - fit/dataset.py: FitPointDataset orchestrating all point observables - fit/fluxes.py: FitFluxes magnification-based flux-ratio fit - fit/times_delays.py: FitTimeDelays Fermat-potential time-delay fit - fit/positions/abstract.py: AbstractFitPositions base - fit/positions/image/abstract.py: image-plane pairing strategies - fit/positions/source/separations.py: source-plane convergence fit - max_separation.py: SourceMaxSeparation fast position statistic - model/analysis.py: AnalysisPoint log_likelihood_function 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 twelve modules in
autolens/point/:dataset.py—PointDatasetandPointDictdata structuressolver/point_solver.py— triangle-tiling image-position solversolver/shape_solver.py— abstract triangle solver andShapeSolverfit/abstract.py—AbstractFitPointshared base classfit/dataset.py—FitPointDatasetorchestrating all point observablesfit/fluxes.py—FitFluxesmagnification-based flux-ratio fitfit/times_delays.py—FitTimeDelaysFermat-potential time-delay fitfit/positions/abstract.py—AbstractFitPositionsbasefit/positions/image/abstract.py— image-plane pairing strategiesfit/positions/source/separations.py— source-plane convergence fitmax_separation.py—SourceMaxSeparationfast position statisticmodel/analysis.py—AnalysisPointlog_likelihood_functionTest plan
🤖 Generated with Claude Code