Repository navigation
docs: fix docstrings whose parameters don't match the signature (SIT-422) - #1311
Merged
ajkswamy merged 2 commits intoNov 11, 2026
Merged
Conversation
…422) Docstring-only corrections found by pydoclint (hook proposed separately in scverse#1306): get_extent parameters filed under Returns, a PLACEHOLDER block and duplicated min/max docs in _bounding_box_mask_points, Returns/Notes sections that didn't parse, undocumented parameters, and missing Returns/Yields sections.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1311 +/- ##
=======================================
Coverage 91.43% 91.43%
=======================================
Files 53 53
Lines 8395 8395
=======================================
Hits 7676 7676
Misses 719 719
🚀 New features to boost your workflow:
|
jan-glx
marked this pull request as draft
November 11, 2026 10:19
jan-glx
marked this pull request as ready for review
November 11, 2026 10:27
…gle-box shape for max_coordinate The shared strings carried their own first-line indent, so wherever the placeholder sits at the description column the first line rendered 4 spaces too deep. Also document the (n_axes,) single-box form for max_coordinate, as for min_coordinate.
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
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.
Docstring-only fixes split out of #1306 (SIT-422), so they can go in independently of the decision on the pydoclint hook. #1306 now contains only the hook and its config, and needs this PR merged first for its check to pass.
Found by running pydoclint over
src/:get_extent: most parameters were filed under Returns, and the return value was described wrongly_bounding_box_mask_points: a leftoverPLACEHOLDERblock, and the shared min/max coordinate docs pasted in twicemin_coordinate/max_coordinatedocs: the first line rendered 4 spaces deeper than the rest (also onmaininBoundingBoxRequestandbounding_box_query), andmax_coordinatenow mentions the(n_axes,)single-box shape likemin_coordinatedoes-------underline)name: type, which numpydoc parses as a parameter calledname: type; the types already live in the signatures, so only the names are keptc_coords(blobs),suppress_z_warning,sdata,zarr_path,intermediate_coordinate_systems, …bounding_box_query's dispatch-only**kwargs), clarifiediterate_pyramid_levelsyieldsThe
# noqacomments for the intentional mismatches (singledispatch generics) are part of #1306, since they only matter with the hook.No code changes.