Deprecate cf_units.util.approx_equal
#316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lbdreyer
reviewed
Nov 9, 2022
There was a problem hiding this comment.
Thanks for doing this @rcomer !
The trouble with not including the deprecation in the docstring is that there is always the risk that we change the cf-units docs such that it starts publishing the cf_units.util API, and that this is done before we remove cf_units.util.approx_equal. Do you mind adding a small mention of the deprecation on the off chance this happens?
|
@lbdreyer done. Though obviously I have no way to check whether it would render as expected! |
lbdreyer
approved these changes
Nov 9, 2022
|
Thanks @lbdreyer! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Pull Request
Description
As for SciTools/iris#4514, I don't think we need to be maintaining this function. Unlike the Iris version, I didn't bother updating the docstring, because this function isn't included in the cf-units docs!