Utils¶
- surfalize.utils.approximately_equal(a, b, epsilon=1e-06)¶
Check if two floating point values are approximately equal.
- Parameters:
- afloat
First value.
- bfloat
Second value.
- epsilonfloat
Maximum tolerated difference between the floating point values. Defaults to 1e-6.
- Returns:
- bool
- surfalize.utils.is_list_like(obj)¶
Determines whether an object is list-like.
- Parameters:
- objobject
- Returns:
- bool
True if object is list-like, False if is is not.
- surfalize.utils.remove_parameter_from_docstring(parameter, docstring)¶
Removes the documentation of a parameter from a function’s docstring. Returns the processed docstring.
- Parameters:
- parameterstr
Name of the parameter to be removed.
- docstringstr
Docstring from which the parameter should be removed.
- Returns
- ——-
- str