Re: Documentation for python-evolution - where?

Path	csiph.com!x330-a1.tempe.blueboxinc.net!usenet.pasdenom.info!gegeweb.org!de-l.enfer-du-nord.net!feeder1.enfer-du-nord.net!tudelft.nl!txtfeed1.tudelft.nl!feeder2.cambriumusenet.nl!feed.tweaknews.nl!194.109.133.84.MISMATCH!newsfeed.xs4all.nl!newsfeed5.news.xs4all.nl!newsgate.cistron.nl!newsgate.news.xs4all.nl!194.109.133.85.MISMATCH!newsfeed.xs4all.nl!newsfeed6.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path	<rosuav@gmail.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.006
X-Spam-Evidence	'H': 0.99; 'S': 0.00; 'documenting': 0.07; 'modules.': 0.07; 'python': 0.08; "(it's": 0.09; 'ah,': 0.09; 'revision': 0.09; 'api': 0.09; 'subject:python': 0.10; 'am,': 0.12; 'library': 0.13; 'docstrings': 0.16; 'from:addr:rosuav': 0.16; 'from:name:chris angelico': 0.16; 'problem!': 0.16; '\xa0what': 0.16; 'wrote:': 0.18; 'dec': 0.22; 'header:In-Reply- To:1': 0.22; 'interface': 0.23; 'stops': 0.23; 'library.': 0.24; 'code.': 0.26; "i'm": 0.26; '(and': 0.28; 'message- id:@mail.gmail.com': 0.28; 'subject:?': 0.31; 'tue,': 0.32; 'actually': 0.33; 'it?': 0.33; 'to:addr:python-list': 0.34; 'see,': 0.34; '(not': 0.35; 'recently,': 0.37; 'received:google.com': 0.37; 'not,': 0.37; 'some': 0.38; 'received:209.85': 0.38; 'first.': 0.39; 'help': 0.39; "it's": 0.40; 'received:209': 0.40; 'to:addr:python.org': 0.40; 'more': 0.61; '2011': 0.61; 'worth': 0.61; 'your': 0.61; 'link': 0.63; 'high': 0.67; 'incorporate': 0.67; 'received:209.85.216.174': 0.80; 'is)': 0.84
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type:content-transfer-encoding; bh=v0BKfsnADuaFBaJUMIuNIHtcchQHoFd95A+0ESR/OHA=; b=jX+14isQLVQjniGkiBusT76Z38i63lar5CByr3TRfRciiXUmMq0aCPqRBriCU5AAVe XW4Fk3Z6RzUu2YE/pM6h1i4gO6yCDr6fSF9GYGedLGkVpsQC0aarYO+QmqlFkwJfIWtD i7+w6TPYfEJOZWYuTFsEeV0HTZkmBo7yxdxTE=
MIME-Version	1.0
In-Reply-To	<bdnhr8-aou.ln1@chris.zbmc.eu>
References	<3dnfr8-h6a.ln1@chris.zbmc.eu> <mailman.3523.1323652415.27778.python-list@python.org> <bdnhr8-aou.ln1@chris.zbmc.eu>
Date	Tue, 13 Dec 2011 07:49:27 +1100
Subject	Re: Documentation for python-evolution - where?
From	Chris Angelico <rosuav@gmail.com>
To	python-list@python.org
Content-Type	text/plain; charset=ISO-8859-1
Content-Transfer-Encoding	quoted-printable
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.12
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<http://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	<http://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.3567.1323722970.27778.python-list@python.org> (permalink)
Lines	20
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1323722970 news.xs4all.nl 6872 [2001:888:2000:d::a6]:53645
X-Complaints-To	abuse@xs4all.nl
Xref	x330-a1.tempe.blueboxinc.net comp.lang.python:17080

Show key headers only | View raw

On Tue, Dec 13, 2011 at 3:40 AM,  <tinnews@isbd.co.uk> wrote:
> Actually I'm not sure if it's down to the docstrings because the help
> available from Python itself stops (not unreasonably) at the interface
> to the C library code.  What I was after (and you have told me where
> it is) was the functions/methods available from the C library.

Ah, yes, I know that problem! Let's see, how many high level
languages/libraries have I used that have simply exposed a lower-level
API without documenting it? REXX/REXXUtil and SysSetObjectData was the
first. More recently, Pike and the GTK/GTK2 modules. In between, oh so
many others.

Depending on how much is exposed and how transparent the local layer,
it may still be worth writing up some better documentation. Or if not,
it may be of value for the docs to incorporate a link to some
"upstream documentation", which would accomplish the same thing. (It's
a shot at immortality - get your name in a big project's revision
history!)

ChrisA

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

Thread

Documentation for python-evolution - where? tinnews@isbd.co.uk - 2011-12-11 22:28 +0000
  Re: Documentation for python-evolution - where? Chris Angelico <rosuav@gmail.com> - 2011-12-12 12:13 +1100
    Re: Documentation for python-evolution - where? tinnews@isbd.co.uk - 2011-12-12 16:40 +0000
      Re: Documentation for python-evolution - where? Chris Angelico <rosuav@gmail.com> - 2011-12-13 07:49 +1100

csiph-web