Skip to content

Update docs CubeList.extract method #3694

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 3, 2020
Merged

Update docs CubeList.extract method #3694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/iris/src/whatsnew/contributions_3.0.0/docchange_2020-Apr-03_extract_clarification.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Updated the documentation for the :meth:`iris.cube.CubeList.extract` method, to specify when a single cube, as opposed to a CubeList, may be returned.
3 changes: 2 additions & 1 deletion lib/iris/cube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,8 @@ def extract(self, constraints, strict=False):

* strict - boolean
If strict is True, then there must be exactly one cube which is
filtered per constraint.
filtered per constraint. Note: if a single constraint is given, a
Cube is returned rather than a CubeList.

"""
return self._extract_and_merge(
Expand Down