Skip to content
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

DOC: improve gallery test instructions #5100

Merged
merged 1 commit into from
Dec 9, 2022

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Dec 8, 2022

🚀 Pull Request

Description

Since #4792, it is no longer necessary to add a test file with each new gallery entry, because we generate them using glob:

def gallery_examples():
"""Generator to yield all current gallery examples."""
for example_file in GALLERY_DIR.glob("*/plot*.py"):
yield example_file.stem

I also added some links from the gallery testing instructions to the image testing instructions, as I was struggling to find my way around when recently wanting to update a gallery test image file.


Consult Iris pull request check list

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

Thanks @rcomer!

@trexfeathers trexfeathers merged commit 6eb0401 into SciTools:main Dec 9, 2022
@rcomer rcomer deleted the doc-changing-gallery branch December 9, 2022 12:03
tkknight added a commit to tkknight/iris that referenced this pull request Jan 5, 2023
* upstream/main: (167 commits)
  pip pin for sphinx<5 (SciTools#5122)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5120)
  Bump actions/stale from 6 to 7 (SciTools#5117)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5114)
  Correct heading for v3.4 release highlights. (SciTools#5110)
  Announce @ESadek-MO as a core Iris developer. (SciTools#5111)
  Remove test timings (SciTools#5101)
  Switch order of options and parameter in `ncgen` command (SciTools#5105)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5107)
  Updated environment lockfiles (SciTools#5104)
  DOC: improve gallery test instructions (SciTools#5100)
  Updated environment lockfiles (SciTools#5092)
  Update What's New for 3.4 release. (SciTools#5088)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5086)
  Updated environment lockfiles (SciTools#5085)
  Updated environment lockfiles (SciTools#5080)
  Restore latest What's New files.
  Documentation updates for `v3.4.0rc0` release. (SciTools#5078)
  What's New fixes. (SciTools#5077)
  More accurate netcdf4 pin `<1.6.1`. (SciTools#5075)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants