cf.CoordinateReference.dump

CoordinateReference.dump(display=True, omit=(), field=None, key=None, _level=0, _title=None)

Return a string containing a full description of the coordinate reference object.

Parameters:

display: bool, optional

If False then return the description as a string. By default the description is printed, i.e. c.dump() is equivalent to print c.dump(display=False).

field: cf.Field, optional

key: str, optional

Ignored.

Returns:

out: None or str

Examples: