Skip to content

Move doctesting part of refguide-check into a separate cross-project tool#21962

Closed
ev-br wants to merge 7 commits intonumpy:mainfrom
ev-br:doctests
Closed

Move doctesting part of refguide-check into a separate cross-project tool#21962
ev-br wants to merge 7 commits intonumpy:mainfrom
ev-br:doctests

Conversation

@ev-br
Copy link
Contributor

@ev-br ev-br commented Jul 10, 2022

Following up on #21070, here is a proof-of-concept implementation of the doctesting part of refguide-check, with the main implementation common to numpy and scipy (and whoever else wants to take it for a ride).

The matching scipy PR, scipy/scipy#16391, runs with warnings turned to errors, while this one is not.

I'm not sure if I activated the CI correctly, but anyway, locally it's plumbed through runtests.py, so

 $ python runtests.py --doctests -v

does the trick (after $ python -mpip install git+https://github.com/ev-br/scpdt.git).

Several things here are still WIP:

Modulo these, the main thing is there and ready for a spin :-).

@ev-br ev-br changed the title Doctests Move doctesting part of refguide-check into a separate cross-project tool Jul 10, 2022
@mattip
Copy link
Member

mattip commented Dec 15, 2022

It seems the parallel PR in scipy/scipy#16391 got more review. Linting here is failing, but the test itself seems to be passing (logs were removed but there is a green checkmark on the macOS build). I find the choice of tacking the doctests on to the macOS CI run in azure a strange one, but that is the way we have been doing it historically. It might make sense to add doctest runs to a linux and windows CI run. Is there any thought to the tasks at the beginning of the PR, in particular the location/name of the script? In any case we should pin to a known tag/version of the script.

@rgommers
Copy link
Member

@ev-br is any of this still relevant, or can this PR be closed? Superseded by gh-26604 I think?

@ev-br ev-br closed this Jun 16, 2024
@ev-br
Copy link
Contributor Author

ev-br commented Jun 16, 2024

Yup, indeed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants