Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > comp.lang.python > #61210 > unrolled thread

Re: interactive help on the base object

Started byTerry Reedy <tjreedy@udel.edu>
First post2013-12-06 20:35 -0500
Last post2013-12-06 20:35 -0500
Articles 1 — 1 participant

Back to article view | Back to comp.lang.python

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.


Contents

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

#61210 — Re: interactive help on the base object

FromTerry Reedy <tjreedy@udel.edu>
Date2013-12-06 20:35 -0500
SubjectRe: interactive help on the base object
Message-ID<mailman.3685.1386380132.18130.python-list@python.org>
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

[toc] | [standalone]


Back to top | Article view | comp.lang.python


csiph-web