Skip to content

Conversation

@schillic
Copy link
Member

@schillic schillic commented Nov 24, 2024

This PR is undoing #100.

I am actually not convinced that this is a good idea. But I would like to discuss what the right way is in general (run doctests with the docs or with the normal tests). Currently, we only run the doctests with the normal tests here and in ReachabilityBase.

Consequences of this change

  • The docs run becomes much heavier, as it needs to build all optional packages (from 3 min to 6 min). (At least in this package; in other packages, we create code depending on whether these packages are loaded, so we need to load them anyway in the normal docs run).
  • The test run gets a bit lighter, as Documenter is not built anymore and the doctests are not checked (from 6 min to 6 min on Ubuntu and from 20 min to 14 min on Windows). The latter gain should be minimal, given that the test run has already built the optional packages and compiled the functions used in the doctests.
  • Code coverage is only measured in the test run. So if a doctest uses code that is not used in other tests, it would only count toward the coverage in the test run.

@schillic schillic marked this pull request as ready for review November 24, 2024 15:15
@schillic schillic force-pushed the schillic/doctest_run branch from 09861c6 to bd4233a Compare April 19, 2025 06:53
@schillic schillic merged commit 6d5ee68 into master Jul 19, 2025
7 checks passed
@schillic schillic deleted the schillic/doctest_run branch July 19, 2025 16:49
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.

2 participants