cf.Field.dump

Field.dump(complete=False, display=True, level=0, title='Field', q='=')

Return a string containing a description of the field.

The description described without abbreviation with the exception of data arrays, which are abbreviated to their first and last values, and fields contained in transforms and ancillary variables are given as one-line summaries.

Parameters :

complete : bool, optional

Output a complete dump. Fields contained in transforms and ancillary variables are themselves described with their dumps.

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

level : int, optional

title : str, optional

q : str, optional

Returns :

out : None or str

A string containing the description.

Examples