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: Fix _nan_allsame example prompt. #19203

Merged
merged 1 commit into from Sep 7, 2023
Merged

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Sep 7, 2023

without the leading prompt this is interpreted as the result the previous line should produce.

--

Note that _nan_allsame is used in a single place that uses keepdims=True, there might be some simplification possible

without the leading prompt this is interpreted as the result the
previous line should produce.
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.

Clearly correct, thanks. A little strange that our refguide checker didn't catch this one.

@rgommers rgommers merged commit b426053 into scipy:main Sep 7, 2023
18 of 24 checks passed
@rgommers rgommers added this to the 1.12.0 milestone Sep 7, 2023
@Carreau
Copy link
Contributor Author

Carreau commented Sep 7, 2023

I don't think those functions are checked or present in the docs, which should explain why maybe.

@ev-br
Copy link
Member

ev-br commented Sep 7, 2023

Yeah, refguide-checker only looks at docstrings of public objects currently. Sheila is working on an improvement at scipy/scipy_doctest#91 , expect a scipy PR soon (tm).
Doctest discovery with pytest is surprisingly tricky

@Carreau Carreau deleted the nanallsame-doc branch September 12, 2023 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants