Use @deprecated library
Created originally on Bitbucket by Tantale (Laurent LAPORTE)
Hi Charlie & Co.
I have just seen that you use an "enhanced" copy of the Deprecated library. But this version is old now and have limitations (i.e.: you can't decorate classes).
The new version (1.2.x branch) has support for Sphinx directives. So you can decorate a deprecated function/method/class and update its docstring.
For instance:
from deprecated.sphinx import deprecated
@deprecated(version='1.0', reason="This function will be removed soon")
def function_three():
'''This is the function three'''
It will add the .. deprecated::
directive automatically.
Also take into consideration that this new implementation uses Wrapt, which allows an efficient implementation of decorators.
As you know, I am the author of this library, I think it would be great to use it in OpenPyXl.
Regards,
– Laurent.