Improve docs.

[pyutils.git] / src / pyutils / decorator_utils.py

diff --git a/src/pyutils/decorator_utils.py b/src/pyutils/decorator_utils.py
index e8d2249c2b1c785b51ec5e3a02e3417f09e12a89..30b1bfb6f756324981563e6d7345dd81d2e25cde 100644 (file)
--- a/src/pyutils/decorator_utils.py
+++ b/src/pyutils/decorator_utils.py
@@ -488,6 +488,11 @@ def deprecated(func):
     """This is a decorator which can be used to mark functions
     as deprecated. It will result in a warning being emitted
     when the function is used.
+
+    >>> @deprecated
+    ... def foo() -> None:
+    ...     pass
+    >>> foo()   # prints + logs "Call to deprecated function foo"
     """
 
     @functools.wraps(func)