[docs] [issue10669] Document Deprecation Warnings and how to fix

Ezio Melotti report at bugs.python.org
Sat Dec 11 07:55:04 CET 2010


Ezio Melotti <ezio.melotti at gmail.com> added the comment:

The deprecation notes in the doc should be quite easy to find and can be more verbose, but there are a few cases where the deprecation is not about a specific function but something more "abstract" (e.g. some syntax change, or the "Overriding __eq__ blocks inheritance of __hash__ in 3.x" reported by the OP).
Listing new deprecations in the what's new it's a good idea, but otherwise a clear message (that also suggests how to fix the problem) and a deprecation note in the doc (using the '.. deprecated::' directive) should be enough.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10669>
_______________________________________


More information about the docs mailing list