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

DOC: ndimage convolve origin documentation (#14745) #14877

Merged

Conversation

alexandschaefer
Copy link
Contributor

@alexandschaefer alexandschaefer commented Oct 18, 2021

gh-14745

Reference issue

What does this implement/fix?

Fixes incorrect assignment of left and right in current documentation.

Additional information

@tylerjereddy tylerjereddy added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Oct 19, 2021
@rgommers rgommers added this to the 1.9.0 milestone Dec 13, 2021
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks @alexandschaefer. This fixes the obvious bug in the description. Did you consider adopting the proposed more extensive description from gh-14745? The ascii visualization used there seems nice. It'll render fine in html if you use reST markup like this I expect (double colon plus blank lines around the content to be typeset):

    Visualizations with an input of length 5 and a filter of length 3::

         origin of 0     origin of -1     origin of 1
         -----           -----            -----
        ---            ---                ---

@alexandschaefer
Copy link
Contributor Author

alexandschaefer commented Dec 13, 2021

Thanks @alexandschaefer. This fixes the obvious bug in the description. Did you consider adopting the proposed more extensive description from gh-14745? The ascii visualization used there seems nice. It'll render fine in html if you use reST markup like this I expect (double colon plus blank lines around the content to be typeset):

    Visualizations with an input of length 5 and a filter of length 3::

         origin of 0     origin of -1     origin of 1
         -----           -----            -----
        ---            ---                ---

Hi @rgommers. Thank you for approving.

To your question. I considered but did not like visualization: I do not think it is very obvious what input and output is (to someone who needs to read it). Also it seems that the output is shifted by ~3 whitespaces.

@rgommers
Copy link
Member

Okay, thanks for considering it. In it goes then.

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.ndimage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants