Show acceptable image test results in the docs #4392
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bjlittle
requested changes
Jan 4, 2022
There was a problem hiding this comment.
@jamesp This is really awesome! Thanks 👍
My only comment is that Python files under docs/src/sphinxext are explicitly not checked by black, flake8 or isort... happy to live with that if you are?
The alternative is either:
- we add exceptions to the rule for the linters et al configurations
- manually lint (I'm assuming that this code will be pretty stable and not subject to much change)
- we move
docs/src/sphinxext/image_test_output.pyto live somewhere else and somehow hook it in
|
I'm happy to do a manual run of those tools over this code 👍 |
bjlittle
approved these changes
Jan 4, 2022
|
@jamesp Works for me dude, nice one 🤟 |
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Jan 5, 2022
* main: rtd with latest mambaforge image for faster building (SciTools#4476) Show acceptable image test results in the docs (SciTools#4392) Nc load latlon fix (SciTools#4470) update matplotlib links (SciTools#4474) Whatsnew for PR 4462 (SciTools#4475) Clarify the return type of iris.load (AVD-1899) (SciTools#4462) [pre-commit.ci] pre-commit autoupdate (SciTools#4472) Updated environment lockfiles (SciTools#4467)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Jan 6, 2022
* main: Use partial to make cube pickleable (SciTools#4377) Add edit via github method to Iris docs (SciTools#4461) Broken cartopy links in docs (SciTools#4464) rtd with latest mambaforge image for faster building (SciTools#4476) Show acceptable image test results in the docs (SciTools#4392) Nc load latlon fix (SciTools#4470) update matplotlib links (SciTools#4474) Whatsnew for PR 4462 (SciTools#4475) Clarify the return type of iris.load (AVD-1899) (SciTools#4462) [pre-commit.ci] pre-commit autoupdate (SciTools#4472) Updated environment lockfiles (SciTools#4467)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Pull Request
Description
There are times when I am running the tests on awkward remote platforms and I get failures due to hamming distance of graphical tests failing. It would be helpful in these circumstances to see the contents of scitools/test-iris-imagehash ordered by test, rather than hash.
This PR adds autogenerated pages to the iris docs that show, by test, the acceptable image results.
The pages added:
imagerepo.json:The images are linked and loaded directly from the scitools/test-iris-imagehash repository.
Consult Iris pull request check list