Skip to content

Pure doctests - #7286

Draft
pp-mo wants to merge 13 commits into
SciTools:mainfrom
pp-mo:pure_doctests
Draft

pp-mo wants to merge 13 commits into
SciTools:mainfrom
pp-mo:pure_doctests

Conversation

@pp-mo

@pp-mo pp-mo commented Sep 21, 2026

Copy link
Copy Markdown
Member

Description

A so-far highly sketchy look at what it might take to adopt the intended future "doctest runner" from ncdata into Iris.

In practice, the doctest-runner code should go into a shared template.

In short:

  • It decouples the doctests from Sphinx, and make them much faster + can run just the ones you want.
  • But it means a fair bit of work re-formatting as the existing testsetup/testcleanup sections are in a Sphinx-specific format.
    • ..and the functionality isn't the same either.

@github-actions github-actions Bot added the benchmark_this Request that this pull request be benchmarked to check if it introduces performance shifts label Sep 21, 2026

@scitools-ci scitools-ci Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Templating

This PR includes changes that may be worth sharing via templating. For each file listed below, please either:

  • Action the suggestion via a pull request editing/adding the relevant file in the SciTools/.github templates/ directory. 1
  • Raise an issue against the SciTools/.github repo for the above action if you really don't have 10mins spare right now. Include an assignee, to avoid it being forgotten.
  • Dismiss the suggestion if the changes are not suitable for templating.

You will need to dismiss this review before this PR can be merged. Recommend the reviewer does this as their final action before merging, as this text will continually update as commits come in.

Templated files

The following changed files are templated:

Template candidates

The following changed files are not currently templated, but their parent directories suggest they may be good candidates for a new template to be created:

Footnotes

  1. Include this text in the PR body to avoid any notifications about applying the template changes back to the source repo!
    @scitools-templating: please no update notification on: iris

@pp-mo
pp-mo marked this pull request as draft September 21, 2026 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

benchmark_this Request that this pull request be benchmarked to check if it introduces performance shifts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant