Re: interactive help on the base object

From	Terry Reedy <tjreedy@udel.edu>
Subject	Re: interactive help on the base object
Date	2013-12-06 20:35 -0500
References	<l7t00b$hp7$1@ger.gmane.org>
Newsgroups	comp.lang.python
Message-ID	<mailman.3685.1386380132.18130.python-list@python.org> (permalink)

Show all headers | View raw

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

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Re: interactive help on the base object Terry Reedy <tjreedy@udel.edu> - 2013-12-06 20:35 -0500

csiph-web