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

MAINT/DOC: Doctests fix scpdt 1.6 #22107

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Conversation

ev-br
Copy link
Member

@ev-br ev-br commented Dec 17, 2024

Fix/skip several issues in docstring examples, smoked out by the recent scipy_doctest==1.6 update.

In short, the update fixes a problem with collections, several docstrings were never tested, and now they are, and the results are not entirely unexpected.

cross-ref a related issue in numpy: numpy/numpy#28019

cc @tylerjereddy you might want to either backport this PR or pin scipy-doctest==1.5.1 in the maintenance branch

Matlab{Object,Function} inherit from np.ndarray; examples
from {ndarray.strides,shape,fields} are broken. Should
probably keep skipping in scipy until
numpy/numpy#28019 is fixed.
@ev-br ev-br added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks labels Dec 17, 2024
@lucascolley lucascolley changed the title Doctests fix scpdt 1.6 MAINT/DOC: Doctests fix scpdt 1.6 Dec 17, 2024
@lucascolley lucascolley added this to the 1.15.0 milestone Dec 17, 2024
@ev-br
Copy link
Member Author

ev-br commented Dec 17, 2024

Would be good to merge somewhat quickly, if only to limit the confusion when things start failing in unrelated PRs.

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks!

@j-bowhay j-bowhay added the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label Dec 17, 2024
@j-bowhay j-bowhay merged commit 05f2abe into scipy:main Dec 17, 2024
38 checks passed
@tylerjereddy tylerjereddy removed the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label Dec 24, 2024
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 maintenance Items related to regular maintenance tasks scipy.sparse.linalg
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants