Re: interactive help on the base object

Path	csiph.com!usenet.pasdenom.info!aioe.org!news.stack.nl!newsfeed.xs4all.nl!newsfeed4.news.xs4all.nl!xs4all!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path	<python-python-list@m.gmane.org>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.003
X-Spam-Evidence	'H': 0.99; 'S': 0.00; 'subject:help': 0.08; 'classes.': 0.09; 'inherited': 0.09; 'interpreted': 0.09; 'lawrence': 0.09; 'received:80.91': 0.09; 'received:80.91.229': 0.09; 'received:gmane.org': 0.09; 'received:list': 0.09; 'python': 0.11; 'jan': 0.12; "'''": 0.16; 'better?': 0.16; 'index.': 0.16; 'received:80.91.229.3': 0.16; 'received:plane.gmane.org': 0.16; 'reedy': 0.16; 'subject:object': 0.16; 'wrote:': 0.18; 'module': 0.19; 'basically': 0.19; '>>>': 0.22; 'issue.': 0.22; 'manual': 0.22; 'header:User-Agent:1': 0.23; 'pointer': 0.24; 'tracker': 0.26; 'header:X-Complaints-To:1': 0.27; 'header:In-Reply-To:1': 0.27; 'class': 0.32; 'open': 0.33; 'url:python': 0.33; 'subject:the': 0.34; 'could': 0.34; 'classes': 0.35; 'something': 0.35; 'belong': 0.36; 'surely': 0.36; 'words,': 0.36; 'url:org': 0.36; 'should': 0.36; 'url:library': 0.38; 'to:addr:python-list': 0.38; 'pm,': 0.38; 'to:addr:python.org': 0.39; 'received:org': 0.40; 'how': 0.40; 'most': 0.60; 'url:3': 0.61; 'received:173': 0.61; 'more': 0.64; 'default': 0.69; 'improved.': 0.84; 'received:fios.verizon.net': 0.84; 'subject:base': 0.84; 'url:html#object': 0.84
X-Injected-Via-Gmane	http://gmane.org/
To	python-list@python.org
From	Terry Reedy <tjreedy@udel.edu>
Subject	Re: interactive help on the base object
Date	Fri, 06 Dec 2013 20:35:15 -0500
References	<l7t00b$hp7$1@ger.gmane.org>
Mime-Version	1.0
Content-Type	text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding	7bit
X-Gmane-NNTP-Posting-Host	pool-173-75-254-207.phlapa.fios.verizon.net
User-Agent	Mozilla/5.0 (Windows NT 6.1; WOW64; rv:24.0) Gecko/20100101 Thunderbird/24.1.1
In-Reply-To	<l7t00b$hp7$1@ger.gmane.org>
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.15
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list/>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.3685.1386380132.18130.python-list@python.org> (permalink)
Lines	33
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1386380132 news.xs4all.nl 2939 [2001:888:2000:d::a6]:60271
X-Complaints-To	abuse@xs4all.nl
Xref	csiph.com comp.lang.python:61210

Show key headers only | 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