docs: refactor and complete docstrings for autoarray/dataset#224
Merged
docs: refactor and complete docstrings for autoarray/dataset#224
Conversation
- interferometer/simulator.py: complete rewrite of class and method docstrings,
which incorrectly described an Imaging observation with non-existent parameters
- interferometer/dataset.py: rewrite from_fits docstring (was describing unit
conversions that don't exist); add docstrings to all undocumented properties
(amplitudes, phases, uv_distances, dirty_image, dirty_noise_map,
dirty_signal_to_noise_map, signal_to_noise_map, mask, psf, output_to_fits);
document psf_precision_operator_from; fix apply_sparse_operator Parameters/Returns;
add sparse_operator and raise_error_dft_visibilities_limit to __init__ Parameters
- imaging/dataset.py: fix apply_sparse_operator and apply_sparse_operator_cpu
docstrings which had Parameters listed under Returns; add psf_setup_state
description; expand apply_mask to describe covariance trimming and PSF state
- abstract/dataset.py: fix signal_to_noise_map and signal_to_noise_max phrasing;
add docstrings to all undocumented properties (grid, shape_native, shape_slim,
pixel_scales, mask, apply_over_sampling); add trimmed_after_convolution_from docstring
- grids.py: add docstrings to lp, pixelization, blurring, border_relocator properties;
add mask to GridsDataset Parameters; add GridsInterface class docstring
- imaging/simulator.py: fix two typos ("simulaiton", "dirrection"); document xp
and over_sample_size parameters in via_image_from
- mock/mock_dataset.py: add full class and __init__ docstring
- preprocess.py: fix "removedd" typo; fix array_counts_to_eps description which
incorrectly said "eps to counts"
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
interferometer/simulator.py— complete rewrite of class andvia_image_fromdocstrings, which had been incorrectly copy-pasted fromSimulatorImagingand described non-existent parameters (real_space_shape_native,psf,exposure_time_map, etc.)interferometer/dataset.py— rewrotefrom_fits(was describing unit conversions that don't exist); added docstrings to all undocumented properties (amplitudes,phases,uv_distances,dirty_image,dirty_noise_map,dirty_signal_to_noise_map,signal_to_noise_map,mask,psf,output_to_fits); documentedpsf_precision_operator_from; fixedapply_sparse_operatorwhich had Parameters mixed up with Returns; addedsparse_operatorandraise_error_dft_visibilities_limitto__init__Parametersimaging/dataset.py— fixedapply_sparse_operatorandapply_sparse_operator_cpuwhich hadbatch_size/use_jaxlisted underReturnsinstead ofParameters; addedpsf_setup_statedescription; expandedapply_maskto describe covariance matrix trimming and PSF state recomputationabstract/dataset.py— fixed "signal-to-noise_maps mappers" phrasing; added docstrings to all undocumented properties (grid,shape_native,shape_slim,pixel_scales,mask,apply_over_sampling); addedtrimmed_after_convolution_fromdocstring explaining the post-convolution border trimming conceptgrids.py— added docstrings to all fourGridsDatasetproperties (lp,pixelization,blurring,border_relocator); addedmaskto__init__Parameters; added fullGridsInterfaceclass docstringimaging/simulator.py— fixed two typos ("simulaiton" → "simulation", "dirrection" → "diffraction"); documentedxpandover_sample_sizeparameters invia_image_frommock/mock_dataset.py— added full class and__init__docstring explaining the default single-pixel grid behaviourpreprocess.py— fixed "removedd" typo; fixedarray_counts_to_epsdescription which incorrectly said it converted "eps to counts"Test plan
python -c "import autoarray"python -m pytest test_autoarray/🤖 Generated with Claude Code