24 Jul
2005
24 Jul
'05
8:23 p.m.
On 7/24/05, Tim Peters
I'm sure there is <wink>, but via a different route: tools to extract text from the full documentation, not to burden docstrings with an impossible task. Channeling Guido, docstrings are best when they have a "quick reference card" feel, more memory aid than textbook. That doesn't mean it wouldn't also be nice to have "the textbook" online from pydoc/help too, it means that manuals and docstrings serve different purposes.
While I agree that docstrings shouldn't be a deep copy of _Python in a
Nutshell_, there are definitely some areas of the standard library
that could use some help. threading comes to mind immediately.
--
Tim Lesher