MAINT: Harmonized documentation for Interpolator classes #18413
Merged
Conversation
This file contains 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
j-bowhay
added
scipy.interpolate
Documentation
ev-br
reviewed
May 3, 2023
ev-br
approved these changes
May 6, 2023
| axis : int, optional | ||
| Axis in the y array corresponding to the x-coordinate values. | ||
| Axis in the ``y`` array corresponding to the x-coordinate values. Defaults | ||
| to ``axis=0``. |
There was a problem hiding this comment.
So you wanted to stress that by default it's the first axis; do you want try keeping it two ways? Defaults to the first axis, axis=0 or some such?
There was a problem hiding this comment.
Instead, I stressed that unlike other interpolators, the interpolation axis in interp1d is the last one. So as far as I'm concerned I'm happy with this sentence
ev-br
approved these changes
May 6, 2023
ev-br
approved these changes
May 6, 2023
|
Thank you @gjhuizing and congartulations with what I believe is your first scipy commit. Keep them coming! |
|
Thanks a lot for the review! |
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.
Reference issue
#18165 (comment)
What does this implement/fix?
In the documentation, I harmonized and clarified the dimensions of the inputs of *Interpolator objects. I chose the
(npoints, ndims)convention. In addition, since the legacy classinterp1duses the last axis and other interpolators use the first axis by default, I emphasized the default value in the docstring.Additional information
This is a modest change but I'm hoping to motivate more ambitious harmonization of the interpolation module. In particular, naming the inputs
pointsandvaluesin all interpolators would make it easier for the user (see my original issue). In addition, some interpolators allow specifying the interpolation axis while others don't, which prevents the user from seamlessly interchanging one interpolator for another.Best,
GJ