Skip to content

Doc tests using doctest-parallel #1014

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
merged 2 commits into from
Feb 27, 2022
Merged

Doc tests using doctest-parallel #1014

merged 2 commits into from
Feb 27, 2022

Conversation

andreasabel
Copy link
Member

@andreasabel andreasabel commented Feb 14, 2022

This is an alternative to #1013, but it does not work (yet?).

Potential advantages:

  • doctest-parallel is faster
  • no need to move library to src/

UPDATE: moving library sources into src/ made this variant work. It is faster than plain doctest (#1013), so I think I will settle for this alternative.

@martijnbastiaan
Copy link

martijnbastiaan commented Feb 27, 2022

@andreasabel I've released doctest-parallel 0.2.2: https://hackage.haskell.org/package/doctest-parallel-0.2.2. If all is well you can remove the workaround.

`doctest-parallel` (13sec) is faster than plain `doctest` (30sec).
By default, `doctest-parallel` only runs the tests for exported
functions, but this can be worked around if necessary (see docs).
@andreasabel
Copy link
Member Author

@martijnbastiaan: Works like a charm! Thanks!

Manually filtering out auto-generated modules like `Paths_` is no
longer needed with doctest-parallel-0.2.2.
@andreasabel andreasabel self-assigned this Feb 27, 2022
@andreasabel
Copy link
Member Author

CI is failing, but it is not my fault: #996 (comment)
The DocTests pass.

@andreasabel andreasabel merged commit d69f7b6 into master Feb 27, 2022
@andreasabel andreasabel deleted the parallel-doctest branch February 27, 2022 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
re: doctest Concerning doctest suites
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants