cf.FieldList.dump

FieldList.dump(complete=False, display=True, _level=0, _title='Field', _q='=')

For each field, print or return a string containing a description of the field.

By default, the description is given without abbreviation with the exception of data arrays (which are abbreviated to their first and last values) and fields contained in coordinate references and ancillary variables (which are given as one-line summaries).

Examples 1:

>>> f.dump()

Parameters:

complete : bool, optional

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

display : bool, optional

If False then, for each field, return the description as a string. By default the description is printed.

Example:

f.dump() is equivalent to for g in f: print g.dump(display=False).

Returns:

out : None or list

If display is False then, for each field, the description is printed and None is returned. Otherwise a list of strings containing the description for each field is returned.