cfdm.CoordinateReference.dump

CoordinateReference.dump(display=True, _omit_properties=None, field=None, key='', _level=0, _title=None, _construct_names=None, _auxiliary_coordinates=None, _dimension_coordinates=None)

A full description of the coordinate reference construct.

Returns a description of all properties, including those of components.

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