cf.FieldAncillary.dump

FieldAncillary.dump(display=True, _omit_properties=None, _key=None, _level=0, _title=None, _axes=None, _axis_names=None)

A full description of the field ancillary construct.

Returns a description of all properties, including those of components, and provides selected values of all data arrays.

New in version 1.7.0.

Parameters

display: bool, optional

If False then return the description as a string. By default the description is printed.

Returns

None or str

The description. If display is True then the description is printed and None is returned. Otherwise the description is returned as a string.