Skip to content

DOC: ndimage: improve grayscale morphology docstrings #20799

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

Merged

Conversation

grlee77
Copy link
Contributor

@grlee77 grlee77 commented May 26, 2024

The goal of this MR is to make the behavior of the structure argument clearer and avoid confusion as seen, for example, in #19384

@grlee77 grlee77 added scipy.ndimage Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels May 26, 2024
@grlee77 grlee77 self-assigned this May 26, 2024
@grlee77 grlee77 force-pushed the ndimage-improve-structure-documentation branch from f035ba5 to 035978d Compare May 26, 2024 17:32
@grlee77
Copy link
Contributor Author

grlee77 commented May 26, 2024

Looks like there was an unrelated failure in linalg:

scipy/sparse/linalg/tests/test_expm_multiply.py:35: in wrapped
    with pytest.warns(UserWarning,
E   RuntimeWarning: overflow encountered in multiply
        args       = (<5x5 MatrixLinearOperator with dtype=float64>, array([[ 1.22796439, -1.14500358],
       [-1.02018788, -0.39673356],
       [ 0.71869298, -0.84965727],
       [-0.36083862, -0.3083584 ],
       [-0.84761337, -1.80172566]]))
        func       = <function expm_multiply at 0xe588bc40>
        kwds       = {'endpoint': True, 'num': 2, 'start': 0.1, 'stop': 3.2}
=========================== short test summary info ============================
FAILED scipy/sparse/linalg/tests/test_expm_multiply.py::TestExpmActionInterval::test_expm_multiply_interval_matrix
= 1 failed, 49340 passed, 2580 skipped, 11447 deselected, 566 xfailed, 12 xpassed in 632.01s (0:10:32) =

@lucascolley lucascolley changed the title improve grayscale morphology docstrings DOC: ndimage: improve grayscale morphology docstrings May 26, 2024
@lucascolley
Copy link
Member

@RSKothari does this help explain things?

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.

LGTM, thanks @grlee77. This is a clear improvement, so let's get this in right before the release branch creation, so it ends up in docs users will see soon.

@rgommers rgommers merged commit c2be1a4 into scipy:main May 28, 2024
@rgommers rgommers added this to the 1.14.0 milestone May 28, 2024
@RSKothari
Copy link

@lucascolley Yes it helps. Thank you for the improvements.

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.

4 participants