|View source on GitHub|
Decorator for marking specific function argument values as deprecated.
tf.contrib.framework.deprecated_arg_values( date, instructions, warn_once=True, **deprecated_kwargs )
This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument values. It has the following format:
date is None, 'after
It also edits the docstring of the function: ' (deprecated arguments)' is appended to the first line of the docstring and a deprecation notice is prepended to the rest of the docstring.
date: String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None
instructions: String. Instructions on how to update code using the deprecated function.
True, warn only the first time this function is called with deprecated argument values. Otherwise, every call (with a deprecated argument value) will log a warning.
**deprecated_kwargs: The deprecated argument values.
Decorated function or method.
ValueError: If date is not None or in ISO 8601 format, or instructions are empty.