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

Jump to bottom

combined whatsnew entry for discontiguity checking and masking #3188

Closed
wants to merge 1 commit into from
Closed

combined whatsnew entry for discontiguity checking and masking #3188

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
5 changes: 5 additions & 0 deletions ...c/whatsnew/contributions_2.2.0/newfeature_2018-Oct-05_contiguity-checking-and-masking.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* Users can now check their cubes for any discontiguities in bounds arrays
Copy link
Member

Choose a reason for hiding this comment

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

I don't like the use of "users" here. It implies that (a) there's an 'us' (devs) and 'them' (users), and not only that but (b) the whatsnew is by devs and for devs, and that users should be a little uncomfortable to also be here.

That said, it's hard to write these things! You can avoid the 'us' vs 'them' problem by using "you" in place of "users", which is more friendly, or not cast the whatsnew in terms of a person at all:

The function "find_discontiguities_in_bounds" can be used to check for discontiguities in the bounds arrays of cube coordinates.
Additionally, discontiguous points in coordinates can be explicitly masked using "mask_data_at_discontiguities".

Or something.

Copy link
Member

Choose a reason for hiding this comment

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

Well, I didn't expect you to hear you promoting use of the passive voice @dkillick !

Not that I object to that, but I know other people do.

using the function :func:`iris.util.find_discontiguities_in_bounds`.
Additionally, users can choose to mask their data at discontiguous points
with the function :func:`iris.util.mask_data_at_discontiguities`, which could
prevent plotting errors in some cases.