cf.FieldList.dump

FieldList.dump(display=True, _level=0, _title='Field', _q='-')[source]

A full description of each 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:
>>> fl.dump()
Parameters:
display: bool, optional

If False then return the descriptionfor each field as a string. By default the descriptions are printed.

Example:

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

Returns:
out: None or list

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