Skip to content

Change default behaviour of FUTURE option netcdf_promote #2845

@DPeterK

Description

@DPeterK

This involves completing the following work (list may not be complete):

  • set the default value of the FUTURE flag netcdf_promote to True in iris.Future.
  • raise an error iff a user sets a value for this FUTURE flag (that is, raise an error if the flag is set by the user, but don't raise the error when the default behaviour is set up by Iris).
  • delete the deprecated behaviour in iris.fileformats.cf.CFReader._translate and the deprecation warning iris.fileformats.cf._netcdf_promote_warning, and raise an exception if a user tries to set the FUTURE flag to False.
  • update tests (including removing tests for the deprecated behaviour that was removed)
  • add new tests for the updated behaviour of iris.fileformats.cf.CFReader (if necessary – this may have been done already in the previous point) and new tests for the exception raised if the FUTURE flag is set to False.
  • Add a deprecation directive to the description of netcdf_promote in the docstring for iris.Future.
  • Update all doc examples to use the new behaviour
  • Add whatsnew entry.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions