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.

Sign up for GitHub

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

Jump to bottom

DOC: scipy.ndimage.convolve origin parameter #20370

Open
AlexanderForrest opened this issue Apr 1, 2024 · 1 comment · May be fixed by #20408
Open

DOC: scipy.ndimage.convolve origin parameter #20370

AlexanderForrest opened this issue Apr 1, 2024 · 1 comment · May be fixed by #20408
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.ndimage

Comments

@AlexanderForrest
Copy link

Issue with current documentation:

https://scipy.github.io/devdocs/reference/generated/scipy.ndimage.convolve.html#scipy-ndimage-convolve

The ndimage.convolve has the parameter origin, which is listed as type int.

when working with this, it actually appears to take in a sequence with length equal to the number of dimensions.

Idea or request for content:

clarifying the description to be the same as ndimage.correlate:
https://scipy.github.io/devdocs/reference/generated/scipy.ndimage.correlate.html#scipy.ndimage.correlate

Additional context (e.g. screenshots, GIFs)

No response
@AlexanderForrest AlexanderForrest added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Apr 1, 2024
@j-bowhay
Copy link
Member

j-bowhay commented Apr 1, 2024

@AlexanderForrest would you like to make a PR

m-maggi added a commit to m-maggi/scipy that referenced this issue Apr 7, 2024
@m-maggi
DOC docstring of argument origin in ndimage.convolve taken from ndi…
6d8bc98 
…mage.correlate

See scipy#20370

[docs only]
@m-maggi m-maggi linked a pull request Apr 7, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.ndimage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: argument origin in scipy.ndimage.convolve m-maggi/scipy
3 participants
@j-bowhay @AlexanderForrest and others