Improve docstrings for autoarray/fit package#228
Merged
Conversation
- fit_util.py: add docstring to `to_new_array` decorator; remove spurious `mask` param from `residual_map_from` and `normalized_residual_map_from`; fix wrong Parameters in `chi_squared_with_mask_fast_from` (was listing `chi_squared_map`, now lists the actual params: data/mask/model_data/noise_map); fix three "Returnss" typos; fix "o the" typo in `log_evidence_from` - fit_dataset.py: add docstrings to `_xp`, `mask`, `grids`, `data`, `noise_map`, `figure_of_merit`, `reduced_chi_squared`; remove wrong Parameters section from `log_evidence` property; fix "evey" typo - fit_imaging.py: add docstrings to `data` and `blurred_image`; fix "evey" typo - fit_interferometer.py: fix `__init__` parameters (remove non-parameter items `model_data`/`inversion`, fix `MaskedInterferometer` → `Interferometer`); add docstrings to `mask`, `transformer`, and all seven `dirty_*` properties; fix `log_evidence` wrong Parameters section; fix "evey" typo 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_util.py: Added docstring to theto_new_arraydecorator; removed spuriousmaskparameter fromresidual_map_fromandnormalized_residual_map_from; fixed wrongParameterssection inchi_squared_with_mask_fast_from(was listingchi_squared_map, now correctly listsdata/mask/model_data/noise_map); fixed threeReturnsstypos; fixed"o the"→"of the"typo inlog_evidence_fromfit_dataset.py: Added docstrings to_xp,mask,grids,data,noise_map,figure_of_merit,reduced_chi_squared; removed incorrectParameterssection from thelog_evidenceproperty (properties don't have parameters); fixed"evey"typofit_imaging.py: Added docstrings todataandblurred_image; fixed"evey"typofit_interferometer.py: Fixed__init__docstring (removed non-parameter itemsmodel_data/inversion, fixedMaskedInterferometer→Interferometer); added docstrings tomask,transformer, and all sevendirty_*image-space properties; removed incorrectParameterssection fromlog_evidence; fixed"evey"typoTest plan
python -m pytest test_autoarray/🤖 Generated with Claude Code