Comment 2 for bug 35947

Revision history for this message
Robert Collins (lifeless) wrote : Re: [Bug 35947] deprecated_function should offer an explanation

On Wed, 2006-03-22 at 03:08 +0000, Ian Bicking wrote:
> Public bug reported:
> https://launchpad.net/malone/bugs/35947
>
> Affects: bzr (upstream)
> Severity: Normal
> Priority: (none set)
> Status: Unconfirmed
>
> Description:
> There should be an optional (but generally used) second argument to
> deprecated_function that suggests what should be used in lieu of the
> deprecated function.
>
> My first thought seeing a deprecation: deprecated for what?

Thats a good point. We have been putting that in the docstring as Aaron
says, but having it in the decorator still allows it to be put in the
docstring (by the decorator) and does not mean it needs to be put in the
Warning: output.

Patches accepted :).

Rob

--
GPG key available at: <http://www.robertcollins.net/keys.txt>.