cf.Comparison.dump

Comparison.dump(display=True)[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. c.dump() is equivalent to print c.dump(display=False).

Returns :
out : None or str

A string containing the description.

Examples

Previous topic

cf.Comparison.copy

Next topic

cf.Comparison.evaluate

This Page