cfdm.mixin.PropertiesData.dump

PropertiesData.dump(display=True, _key=None, _omit_properties=(), _prefix='', _title=None, _create_title=True, _level=0, _axes=None, _axis_names=None)[source]

A full description.

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:

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