Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Nov 20, 2024
1 parent 458ae29 commit 7fb90be
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions audeer/core/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.python.org/dev/peps/pep-0318/>`_
to mark functions/classes as deprecated.
Expand All @@ -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():
Expand Down

0 comments on commit 7fb90be

Please sign in to comment.