cf.Index.dump

Index.dump(display=True, _key=None, _title=None, _create_title=True, _prefix='', _level=0, _omit_properties=None, _axes=None, _axis_names=None)

A full description of the index variable.

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

New in version (cfdm): 1.7.0

Parameters

display: bool, optional

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

Returns

str or None

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