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 rhettinger
Recipients ncoghlan, rhettinger, serhiy.storchaka
Date 2017-07-21.03:52:36
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1500609156.97.0.231019829326.issue30959@psf.upfronthosting.co.za>
In-reply-to
Content
Pydoc isn't the only tool for looking at docstrings.

I'm worried that you're systematically killing-off useful docstrings because of a world view that all tools will use pydoc and signatures.

As a result, IDLE's tooltips are now useless (this comes up every single day when I teach python courses).  BPython is thrown-off, etc.

Here's one of many problem examples of the docstring losing information:


Python 3.4.4 (v3.4.4:737efcadf5a6, Dec 19 2015, 20:38:52)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> print(sorted.__doc__)
sorted(iterable, key=None, reverse=False) --> new sorted list

>>> print(sorted.__doc__)
Return a new list containing all items from the iterable in ascending order.

A custom key function can be supplied to customize the sort order, and the
reverse flag can be set to request the result in descending order.
History
Date User Action Args
2017-07-21 03:52:37rhettingersetrecipients: + rhettinger, ncoghlan, serhiy.storchaka
2017-07-21 03:52:36rhettingersetmessageid: <1500609156.97.0.231019829326.issue30959@psf.upfronthosting.co.za>
2017-07-21 03:52:36rhettingerlinkissue30959 messages
2017-07-21 03:52:36rhettingercreate