diff options
| author | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-14 20:10:00 +0200 |
|---|---|---|
| committer | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-14 20:10:00 +0200 |
| commit | 93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206 (patch) | |
| tree | cd39aed3f925679bc8a19676ce440703dcd0f6c5 /deprecation.py | |
| parent | aab929e273a41a188a244b5d2c8b3e53408172ab (diff) | |
| download | logilab-common-93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206.tar.gz | |
improve doc for better epydoc generation (again).
Diffstat (limited to 'deprecation.py')
| -rw-r--r-- | deprecation.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/deprecation.py b/deprecation.py index c7ffe59..b103092 100644 --- a/deprecation.py +++ b/deprecation.py @@ -61,9 +61,10 @@ def class_moved(new_class, old_name=None, message=None): def deprecated_function(new_func, message=None): - """creates a function which fires a DeprecationWarning when used + """Creates a function which fires a DeprecationWarning when used. - For example, if <bar> is deprecated in favour of <foo> : + For example, if <bar> is deprecated in favour of <foo>: + >>> bar = deprecated_function(foo, 'bar is deprecated') >>> bar() sample.py:57: DeprecationWarning: bar is deprecated |