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

Clarify the return type of iris.load (AVD-1899) #4462

Merged
merged 2 commits into from
Jan 4, 2022

Conversation

wjbenfold
Copy link
Contributor

🚀 Pull Request

Description

The userguide on loading cubes was potentially misleading in referring to a CubeList as a list of cubes. I've clarified this, whilst dropping the word count of the note it's mentioned in to reduce how much we distract from the main points being made in the section.


Consult Iris pull request check list

Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

Much clearer! I just have a very minor suggestion.

Do you want to add a whatsnew here or separately?

docs/src/userguide/loading_iris_cubes.rst Outdated Show resolved Hide resolved
Clarify wording to avoid overloaded term

Co-authored-by: Ruth Comer <[email protected]>
@wjbenfold wjbenfold mentioned this pull request Jan 4, 2022
@rcomer rcomer merged commit b22940c into SciTools:main Jan 4, 2022
@wjbenfold wjbenfold deleted the wjbenfold-load-cubelist-docs branch January 4, 2022 12:05
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants