simpeg.utils.deprecate_method#
- simpeg.utils.deprecate_method(method, old_name, removal_version=None, future_warn=False, error=False)[source]#
Deprecate method
- Parameters:
- method
method
Current method
- old_name
str
Original name for the now deprecated method
- removal_version
str
,optional
SimPEG version in which the method will be removed from the code base
- future_warnbool, default:
False
If
True
, throw comprehensive warning the method will be deprecated- errorbool, default:
False
Throw error if deprecated method no longer implemented
- method
- Returns:
method
The new method