cf.CellMethods.dump

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

Return a string containing a full description of the instance.

If a cell methods ‘name’ is followed by a ‘*’ then that cell method is relevant to the data in a way which may not be precisely defined its corresponding dimension or dimensions.

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).

prefix
: str, optional

Set the common prefix of component names. By default the instance’s class name is used.
Returns:
out
: None or str

A string containing the description.
Examples: