What's New Regarding rules.py

[LukeC92]

No description provided.

[DPeterK]

Can you put everything that was removed from iris.fileformats.rules into this whatsnew entry, please.

[DPeterK]

You can follow the pattern used by @corinnebosley in #2819.

[DPeterK]

@LukeC92 please add [ci skip] to your commit message.

[corinnebosley]

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?

[DPeterK]

@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.

[DPeterK]

@LukeC92 still a couple of outstanding things...

[DPeterK]

This line needs to be prefixed with "* ".

[DPeterK]

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`.

[LukeC92]

As far as I'm this covers all the changes made in the last 6 months. This covers some or all of the changes in the following Pull Requests: #2806, #2801, #2782, #2791, #2795, #2796, #2794, #2786, #2778, #2777.

[DPeterK]

Thanks @LukeC92.