cf.Data.dump

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

Return a string containing a full description of the instance.

Parameters:
display : bool, optional

If False then return the description as a string. By default the description is printed, i.e. d.dump() is equivalent to print d.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: