obspy.core.util.decorator.deprecated

deprecated(warning_msg=None)

This is a decorator which can be used to mark functions as deprecated.

Note

Actually, this is not a decorator itself but a decorator factory, returning the correct decorator for the specified options. It can be used just like a decorator.

It will result in a warning being emitted when the function is used.