Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note in docs to address issue #3164. #8553

Merged
merged 1 commit into from
Apr 2, 2018
Merged

Note in docs to address issue #3164. #8553

merged 1 commit into from
Apr 2, 2018

Conversation

kyleaoman
Copy link
Contributor

No description provided.

@@ -811,6 +811,9 @@ def __call__(self, x, y, dx=0, dy=0, grid=True):
If `grid` is True: evaluate spline at the grid points
defined by the coordinate arrays x, y. The arrays must be
sorted to increasing order.

Note that the axis ordering is inverted relative to
the output of meshgrid.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the associated issue #3164 does call for some kind of documentation adjustment, but I'm not sure this doc addition within a private class object will be appropriately visible to end users.

Maybe the interpolate experts will correct me on that though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the documentation I was reading yesterday, so it is visible (the function is inherited by, e. g., RectBivariateSpline, that doc page links to call. Might be even better to specify what RBS returns somewhere in its documentation, but this is a start, and would have saved me several hours debugging yesterday.

Copy link
Contributor

@tylerjereddy tylerjereddy Mar 15, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, ok, the change shows up here in the CI render of docs: https://6030-1460385-gh.circle-artifacts.com/0/html-scipyorg/generated/scipy.interpolate.RectBivariateSpline.__call__.html#scipy.interpolate.RectBivariateSpline.__call__

I hadn't looked looked at the docs for the __call__ method itself. Maybe that will suffice, but I'll at least give some time for others to chime in.

@tylerjereddy tylerjereddy added scipy.interpolate Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Mar 15, 2018
@pv pv merged commit 75766ce into scipy:master Apr 2, 2018
@pv pv added this to the 1.1.0 milestone Apr 2, 2018
@tensionhead
Copy link

Just ran into the same issue, and according to

https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.RectBivariateSpline.html#scipy.interpolate.RectBivariateSpline

there is still no change in the docs visible?!

@kyleaoman
Copy link
Contributor Author

kyleaoman commented Jun 5, 2019

Just ran into the same issue, and according to

https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.RectBivariateSpline.html#scipy.interpolate.RectBivariateSpline

there is still no change in the docs visible?!

Under Methods, find __call__, the note is in the docs there. This is the "correct" place for it, but perhaps not as visible as it could be...

https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.RectBivariateSpline.__call__.html#scipy.interpolate.RectBivariateSpline.__call__

@kyleaoman kyleaoman deleted the patch-1 branch June 5, 2019 11:29
@tensionhead
Copy link

Ah yes, there I can see it.. I am however only using the .ev() method, where such a note is absent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.interpolate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants