docs: refactor docstrings for autoarray/mask package#226
Merged
Conversation
- abstract_mask: add docstrings to _xp, mask, dimensions properties;
fix pixel_scale phrasing; fix is_all_false (was backwards)
- mask_2d: add invert/xp to __init__ params; add docstrings to
native_for_slim, derive_indexes, derive_mask, derive_grid, zoom,
shape_native, mask_centre; fix from_fits (was "image", add all params);
fix unmasked_blurred_array_from wrong params; fix "ndarraay" typo
- mask_1d: add invert/xp to __init__ params; fix header_dict (was "2D
mask"); fix all_false ("(y,x)"→"1D"); fix "image image" typo;
add shape_native/shape_slim docstrings; add derive_mask/derive_grid
docstrings; add from_fits Returns
- derive/mask_2d: fix "everu"→"every"; add allow_padding param to
blurring_from
- derive/grid_2d: fix border property incorrectly said "edge grid"
- derive/indexes_2d: fix "71,3]"→"[7,3]" typo
- derive/zoom_2d: fix incomplete class docstring sentence; fix "centred"
phrasing in offset_pixels/offset_scaled; fix extent_from wrong method
reference; add Returns sections throughout
- derive/mask_1d: fix to_mask_2d references "to_mask_1d"
- derive/grid_1d: complete rewrite of class and all_false docstrings
which incorrectly referenced Mask2D/Grid2D/DeriveGrid2D throughout
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
abstract_mask.py: add docstrings to_xp,mask,dimensionsproperties; fixpixel_scalephrasing; fixis_all_false(docstring was backwards — said "ReturnsFalseif all pixels areFalse")mask_2d.py: addinvert/xpto__init__params; add docstrings tonative_for_slim,derive_indexes,derive_mask,derive_grid,zoom,shape_native,mask_centre; fixfrom_fits(said "Loads the image", "image image" typo, missing params); fixunmasked_blurred_array_fromwrong params; fix "ndarraay" typomask_1d.py: addinvert/xpto__init__params; fixheader_dict(said "2D mask"); fixall_false("(y,x) shape" → "1D shape"); fix "image image" typo; addshape_native/shape_slimdocstrings; addfrom_fitsReturnsderive/mask_2d.py: fix "everu"→"every"; addallow_paddingparam toblurring_fromderive/grid_2d.py: fixborderproperty incorrectly said "The edge grid (given via derive_grid.edge)"derive/indexes_2d.py: fix71,3]→[7,3]typoderive/zoom_2d.py: fix incomplete class docstring sentence; fix "centred" phrasing; fixextent_fromwrong method reference (zoomed_around_mask); add Returns sections throughoutderive/mask_1d.py: fixto_mask_2ddocstring said "to_mask_1d"derive/grid_1d.py: complete rewrite of class docstring andall_falsewhich incorrectly referencedMask2D/Grid2D/DeriveGrid2DthroughoutTest plan
python -c "import autoarray"🤖 Generated with Claude Code