fixed typos

Change-Id: Iee7fa515e3c551af6697fcacec88d61a7a023bb2
This commit is contained in:
Dolph Mathews
2013-12-10 08:43:45 -06:00
committed by Doug Hellmann
parent 7c8ebe83f2
commit e00421c325

View File

@@ -30,19 +30,19 @@ LOG = logging.getLogger(__name__)
class deprecated(object):
"""A decorator to mark callables as deprecated.
deprecated logs a deprecation message when the callable it decorates
is used. The message will include the release where the callable was
deprecated, the release where is may be removed and possibly an
optional replacement.
This decorator logs a deprecation message when the callable it decorates is
used. The message will include the release where the callable was
deprecated, the release where it may be removed and possibly an optional
replacement.
Examples:
1. Specifing the required deprecated release
1. Specifying the required deprecated release
>>> @deprecated(as_of=deprecated.ICEHOUSE)
... def a(): pass
2. Specifing a replacement:
2. Specifying a replacement:
>>> @deprecated(as_of=deprecated.ICEHOUSE, in_favor_of='f()')
... def b(): pass