docs(interpolate): add IDW examples and backend-support notes#3547
Merged
brendancol merged 1 commit intoJun 27, 2026
Merged
Conversation
idw() lacked an Examples section and did not document which backends it supports (Cat1/Cat5 from the documentation sweep). Add a runnable Examples block, a backend-support line covering numpy/cupy/dask+numpy/ dask+cupy and the k-nearest CPU-only restriction, and Returns notes for the float64 dtype, NaN/inf input dropping, and zero-weight fill_value. Doc-only: no behavior changes. Tests in test_interpolation.py pass (92).
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.
What
Documentation-only fix for
idw()inxrspatial/interpolate/_idw.py, found by the documentation sweep.Findings
idw()(the only public function in the module) had Parameters/Returns/Raises but no Examples section.ArrayTypeFunctionMapping, the k-nearest path raisesNotImplementedErroron GPU, and NaN/inf input points are dropped, none of which was stated in the docstring.Changes
fill_valuebehavior.No behavior changes.
test_interpolation.pypasses (92 tests). The example output was reproduced exactly against the worktree build.Cat2/Cat3/Cat4 were clean: all nine parameters are documented with matching defaults and types, there were no prior examples to break, and
idwis already listed indocs/source/reference/interpolation.rst.