Move experimental equalise_attributes #3527
Conversation
| new = "iris.util.equalise_attributes" | ||
| emsg = ( | ||
| f'The function "{old}" has been moved.\n' | ||
| f'Please replace "{old}(<cubes>)" with "{new}(<cubes>)".' |
There was a problem hiding this comment.
Ohhh our first f-string 🎉
Welcome to the wonderful world of Python3 (finally!)
| @@ -0,0 +1,2 @@ | |||
| * The :func:`iris.experimental.equalise_cubes.equalise_attributes` function has been migrated into | |||
| the core of Iris. Please use the :func:`iris.util.equalise_attributes` function instead. | |||
There was a problem hiding this comment.
I'm not sure "core of Iris" means that much to someone outside the dev team.
Maybe it is clearer to say:
- The :func:
iris.experimental.equalise_cubes.equalise_attributesfunction has been moved from the :mod:iris.experimentalmodule into :mod:iris.utilmodule. Please use the :func:iris.util.equalise_attributesfunction instead.
| # before importing anything else. | ||
| import iris.tests as tests | ||
|
|
||
| import numpy as np |
There was a problem hiding this comment.
The doc string in the file header still references "experimental". I think it should be iris.util.equalise_attributes:
"""
Unit tests for the :func:iris.experimental.equalise_cubes.equalise_attributes
function.
"""
| cube.data = ma.masked_array(cube.data) | ||
| cube.data[points_to_mask] = ma.masked | ||
| return cube | ||
|
|
There was a problem hiding this comment.
I checked this file: It is identical to before, except for syntax over multiple lines :)
There was a problem hiding this comment.
@abooton Yup, that's the magic of black... or should I say, black magic?! 😉
This PR moves the
iris.experimental.equalise_cubes.equalise_attributesfunction toiris.util.equalise_attributes.Reference #3515