simpeg.utils.deprecate_class#
- simpeg.utils.deprecate_class(removal_version=None, new_location=None, future_warn=False, error=False, replace_docstring=True)[source]#
Utility function to deprecate a class
- Parameters:
- removal_version
str
A string denoting the SimPEG version in which the class will be removed
- new_location
str
Name for the class replacing the deprecated class
- future_warnbool, default:
False
If
True
, throw comprehensive warning the class will be deprecated- errorbool, default:
False
Throw error if deprecated class no longer implemented
- removal_version
- Returns:
class
The new class