simpeg.utils.deprecate_function#
- simpeg.utils.deprecate_function(new_function, old_name, removal_version=None, new_location=None, future_warn=False, error=False)[source]#
Deprecate function
- Parameters:
- new_function
function
Current function
- old_name
str
Original name for the now deprecated function
- 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
- new_function
- Returns:
function
The new function