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

A full description of the field.

The field and its components are described without abbreviation with the exception of data arrays, which are abbreviated to their first and last values.

Examples 1:
>>> f.dump()
display: bool, optional

If False then return the description as a string. By default the description is printed.


f.dump() is equivalent to print f.dump(display=False).

out: None or str

If display is True then the description is printed and None is returned. Otherwise the description is returned as a string.