cf.BoundedVariable.dump

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

Return a string containing a full description of the variable.

New in version 2.0.

Parameters:

display: bool, optional

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

omit: sequence of str

Omit the given CF properties from the description.

Returns:

out : None or str

A string containing the description.

Examples: