Fix doc-string in warn_deprecated_function.

PiperOrigin-RevId: 622155110
google-deepmind · Apr 5, 2024 · 8b889ff · 8b889ff
1 parent f8e309e
commit 8b889ff
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/chex/_src/warnings.py b/chex/_src/warnings.py
@@ -61,9 +61,9 @@ def warn_deprecated_function(fun, replacement):
   """A decorator to mark a function definition as deprecated.
 
   Example usage:
-  @warn_deprecated_function(fun, replacement='g')
-  def f(a, b):
-    return a + b
+  >>> @functools.partial(chex.warn_deprecated_function, replacement='g')
+  ... def f(a, b):
+  ...   return a + b
 
   Args:
     fun: the deprecated function.