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 Tony R., docs@python, eric.araujo, ezio.melotti, georg.brandl
Date 2015-10-26.11:31:06
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1445859067.16.0.232994760849.issue25467@psf.upfronthosting.co.za>
In-reply-to
Content
Thanks for the report and the patch.

I think a better way to handle this would be to add a "tag" next to the function name for both deprecations and "new in", and leave the actual deprecation/new-in notes at the bottom, something like:

funcname(args)  [new in 3.2] [deprecated in 3.5]
  Func description here.

  New in 3.2: the funcname() function was added.
  Deprecated in 3.5: funcname() has been deprecated.  Use anotherfunc() instead.

I've seen other docs doing it, however I'm not sure how easy it would be to implement something similar for Sphinx (maybe it's necessary to redefine the func/meth/class roles).
History
Date User Action Args
2015-10-26 11:31:07ezio.melottisetrecipients: + ezio.melotti, georg.brandl, eric.araujo, docs@python, Tony R.
2015-10-26 11:31:07ezio.melottisetmessageid: <1445859067.16.0.232994760849.issue25467@psf.upfronthosting.co.za>
2015-10-26 11:31:07ezio.melottilinkissue25467 messages
2015-10-26 11:31:06ezio.melotticreate