What's New Regarding rules.py#2821
Conversation
DPeterK
left a comment
There was a problem hiding this comment.
Can you put everything that was removed from iris.fileformats.rules into this whatsnew entry, please.
51e9170 to
0137922
Compare
|
You can follow the pattern used by @corinnebosley in #2819. |
|
@LukeC92 please add |
corinnebosley
left a comment
There was a problem hiding this comment.
I am a little unsure about some of the entries on this list. I know, for example, that some of them are variables (like RuleResult) and that others (like RulesContainer) are only used in other functions.
I think we should remove entries for log, DebugString, FunctionRule, ProcedureRule and Rule.
@dkillick What do you think?
|
@corinnebosley we must document all breaking changes to public API here. So if it's public and we've removed it, we need to document it in this whatsnew entry. |
f0caab2 to
573477e
Compare
| @@ -0,0 +1,12 @@ | |||
| The following classes and functions have been removed from :mod:`iris.fileformats.rules`: | |||
There was a problem hiding this comment.
This line needs to be prefixed with "* ".
| * ```iris.fileformat.rules.ProcedureRule``` | ||
| * ```iris.fileformat.rules.Rule``` | ||
| * ```iris.fileformat.rules.RulesContainer``` | ||
| * ```iris.fileformat.rules.RuleResult``` No newline at end of file |
There was a problem hiding this comment.
You're missing the removal of the legacy_custom_rules keyword arg from the Loader class in this module. Can you add a new line to the end of this document:
* Removed deprecated keyword argument ```legacy_custom_rules``` from :class:`iris.fileformats.rules.Loader`.
|
Thanks @LukeC92. |
No description provided.