From 22fbdc5c744674550be074550862645ddf423b31 Mon Sep 17 00:00:00 2001
From: "chris.burns" <chris.burns@localhost>
Date: Sat, 15 Dec 2007 23:27:14 +0000
Subject: Added docstrings to deprecate funcs

---
 utils.py | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'utils.py')

diff --git a/utils.py b/utils.py
index edde2d168..ab5220c01 100644
--- a/utils.py
+++ b/utils.py
@@ -84,6 +84,15 @@ else:
         return func
 
 def deprecate(func, oldname=None, newname=None):
+    """Deprecate old functions.
+    Issues a DeprecationWarning, adds warning to oldname's docstring,
+    rebinds oldname.__name__ and returns new function object.
+
+    Example:
+    oldfunc = deprecate(newfunc, 'oldfunc', 'newfunc')
+
+    """
+
     import warnings
     if oldname is None:
         oldname = func.func_name
@@ -113,6 +122,17 @@ def deprecate(func, oldname=None, newname=None):
     return newfunc
 
 def deprecate_with_doc(somestr):
+    """Decorator to deprecate functions and provide detailed documentation
+    with 'somestr' that is added to the functions docstring.
+
+    Example:
+    depmsg = 'function numpy.lib.foo has been merged into numpy.lib.io.foobar'
+    @deprecate_with_doc(depmsg)
+    def foo():
+        pass
+
+    """
+
     def _decorator(func):
         newfunc = deprecate(func)
         newfunc.__doc__ += "\n" + somestr
-- 
cgit v1.2.1