Skip to content

Change the documentation of the gradient function that it uses first order central difference in the interior #8607

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

Closed
drabach opened this issue Feb 12, 2017 · 3 comments

Comments

@drabach
Copy link
Contributor

drabach commented Feb 12, 2017

There is a "typo" in the documentation of the gradient function
(https://docs.scipy.org/doc/numpy/reference/generated/numpy.gradient.html).

The implementation is using first order central difference in the interior. But the documentation states that central difference of second order would be used.

I can make a fix available when this issue gets approved.

@eric-wieser
Copy link
Member

eric-wieser commented Jul 13, 2017

You did this (#8605), and then it was reverted (#8606), right?

@drabach
Copy link
Contributor Author

drabach commented Jul 22, 2017

Sorry for this late answer...

Yes, what you state is what happened. Afterwards there was some work where I was not really involved. So I guess the issue got addressed somehow differently.

There are different definitions for "second order" difference. It was proposed at least to give the definition used, inside the documentation - otherwise users might be confused about the outcome of the gradient function as I was. In case the documentation of the gradient function contains the definition now I would say this issue can be closed. But I have not checked it yet.

@eric-wieser
Copy link
Member

Closing - the docs said "second order error", not "second order difference"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants