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.

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

corrected mistakes in contiguity checking docstring #3291

Merged
merged 2 commits into from
Mar 6, 2019
Merged

corrected mistakes in contiguity checking docstring #3291

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62eee92
corrected mistakes in contiguity checking docstring
corinnebosley Mar 6, 2019
8ac4838
license header
corinnebosley Mar 6, 2019
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
9 changes: 4 additions & 5 deletions lib/iris/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2010 - 2018, Met Office
# (C) British Crown Copyright 2010 - 2019, Met Office
#
# This file is part of Iris.
#
Expand Down Expand Up @@ -1611,18 +1611,17 @@ def find_discontiguities(cube, rel_tol=1e-5, abs_tol=1e-8):
discontiguities in the coordinate points array.

This can be used as the input array for
:func:`iris.util.mask_discontiguities`.
:func:`iris.util.mask_cube`.

Examples::

# Find any unknown discontiguities in your cube's x and y arrays:
discontiguities = iris.util.find_discontiguities(cube)

# Pass the resultant boolean array to `iris.util.mask_discontiguities`
# Pass the resultant boolean array to `iris.util.mask_cube`
# with a cube slice; this will use the boolean array to mask
# any discontiguous data points before plotting:
masked_cube_slice = iris.util.mask_discontiguities(cube[0],
discontiguities)
masked_cube_slice = iris.util.mask_cube(cube[0], discontiguities)

# Plot the masked cube slice:
iplt.pcolormesh(masked_cube_slice)
Expand Down