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 refguide check script #25367

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Conversation

mtsokol
Copy link
Member

@mtsokol mtsokol commented Dec 11, 2023

Addresses: #25365

This PR enables running doctests on all docstrings (some docstrings had to be adjusted).

@mtsokol
Copy link
Member Author

mtsokol commented Dec 12, 2023

Now --doctests runs for all non-legacy public modules:

Running checks for 24 modules:
numpy.f2py ....
numpy.linalg ........................................................
numpy.lib .......
numpy.lib.format ...
numpy.lib.mixins ...
numpy.lib.recfunctions .......................
numpy.lib.scimath ....................
numpy.lib.stride_tricks ....
numpy.lib.npyio ...
numpy.lib.introspect ...
numpy.lib.array_utils .....
numpy.fft ....................
numpy.ma ..................................................................................................................................................................................................................................
numpy.polynomial .........
numpy.polynomial.chebyshev ......................................................................
numpy.polynomial.hermite ................................................................
numpy.polynomial.hermite_e ................................................................
numpy.polynomial.laguerre ................................................................
numpy.polynomial.legendre ...............................................................
numpy.polynomial.polynomial ..........................................................
numpy.matrixlib .....
numpy.random .........................................................
numpy.testing .............................................
numpy ..........................................................................................................................................................................................................................Warning: overflow encountered in scalar multiply
.........................................................................................................................................................................................................................................................................

OK: all checks passed!

@rgommers
Copy link
Member

Looks good overall, thanks @mtsokol. Please consider taking over the most recent commit on https://github.com/rgommers/numpy/tree/docs-fix-refguide-check; the added # may vary markers make --doctests pass for me.

@charris charris merged commit a91ed72 into numpy:main Dec 12, 2023
62 checks passed
@charris
Copy link
Member

charris commented Dec 12, 2023

Thanks @mtsokol .

@mtsokol mtsokol deleted the docs-fix-refguide-check branch December 12, 2023 15:55
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.

3 participants