cf.Units.dump

Units.dump(display=True, prefix=None, omit=())[source]

Return a string containing a description of the units.

Parameters :
display : bool, optional

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

Returns :
out : None or str

A string containing the description.

Examples

Previous topic

cf.Units.copy

Next topic

cf.Units.equals

This Page