cf.DomainAncillary.dump

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

Return a string containing a full description of the domain ancillary object.

Parameters:

display: bool, optional

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

field: cf.Field, optional

key: str, optional

Returns:

out: None or str

A string containing the description.

Examples: