This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author ezio.melotti
Recipients docs@python, ezio.melotti, techtonik, vinay.sajip
Date 2011-10-21.02:28:25
SpamBayes Score 1.85021e-11
Marked as misclassified No
Message-id <1319164107.53.0.281640993772.issue13235@psf.upfronthosting.co.za>
In-reply-to
Content
I think it's better to avoid "deprecations by missing documentation" and document explicitly if something is deprecated.
What happens is that people working on some old code find the deprecated method, check the doc to see what it does, don't find anything, get puzzled for a while until they figure out how it works, and then use it.
If they find it and see that is deprecated they will stop using it and start using the right method.
While it's true that new users don't need to know that there's a deprecated method, it's unlikely that they will start using it, so documenting deprecated methods makes more good than harm.
If you want to remove it eventually you'll also have to go through an actual deprecation process with warnings.
History
Date User Action Args
2011-10-21 02:28:27ezio.melottisetrecipients: + ezio.melotti, vinay.sajip, techtonik, docs@python
2011-10-21 02:28:27ezio.melottisetmessageid: <1319164107.53.0.281640993772.issue13235@psf.upfronthosting.co.za>
2011-10-21 02:28:26ezio.melottilinkissue13235 messages
2011-10-21 02:28:25ezio.melotticreate