diff --git a/audeer/core/utils.py b/audeer/core/utils.py index 5592d20..85d8de9 100644 --- a/audeer/core/utils.py +++ b/audeer/core/utils.py @@ -28,7 +28,7 @@ def deprecated( removal_version: str, alternative: str = None, ) -> typing.Callable: - """Mark code as deprecated. + r"""Mark code as deprecated. Provide a `decorator `_ to mark functions/classes as deprecated. @@ -41,13 +41,13 @@ def deprecated( with the next minor release (`X.(Y+1).Z`). Otherwise, choose the next major release (`(X+1).Y.Z`). + .. + >>> import audeer + Args: removal_version: version the code will be removed alternative: alternative code to use - .. - >>> import audeer - Examples: >>> @audeer.deprecated(removal_version="2.0.0") ... def deprecated_function():