interactive help on the base object

Terry Reedy tjreedy at udel.edu
Sat Dec 7 02:35:15 CET 2013


On 12/6/2013 12:03 PM, Mark Lawrence wrote:
> Is it just me, or is this basically useless?
>
>  >>> help(object)
> Help on class object in module builtins:
>
> class object
>   |  The most base type

Given that this can be interpreted as 'least desirable', it could 
definitely be improved.

> Surely a few more words,

How about something like.

'''The default top superclass for all Python classes.

Its methods are inherited by all classes unless overriden.
'''

When you have 1 or more concrete suggestions for the docstring, open a 
tracker issue.

 > or a pointer to this
> http://docs.python.org/3/library/functions.html#object, would be better?

URLs don't belong in docstrings. People should know how to find things 
in the manual index.

-- 
Terry Jan Reedy




More information about the Python-list mailing list