openstack
/
debtcollector
Code Issues Proposed changes

Add removals.remove note about metaclasses 

Change-Id: Ie9264e1b33fd25760d40ae8fd5a2dbfb4b759a22
This commit is contained in:
Joshua Harlow 2015-11-30 16:57:48 -08:00
parent cecf4863cd
commit ca1481ab4c
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
debtcollector/removals.py
View File

@ -164,6 +164,11 @@ def remove(f=None, message=None, version=None, removal_version=None,
stacklevel=3, category=None):
"""Decorates a function, method, or class to emit a deprecation warning
Due to limitations of the wrapt library (and python) itself, if this
is applied to subclasses of metaclasses then it likely will not work
as expected. More information can be found at bug #1520397 to see if
this situation affects your usage of this *universal* decorator.
:param str message: A message to include in the deprecation warning
:param str version: Specify what version the removed function is present in
:param str removal_version: What version the function will be removed. If