Documentation for python-evolution - where?

Chris Angelico rosuav at gmail.com
Mon Dec 12 15:49:27 EST 2011


On Tue, Dec 13, 2011 at 3:40 AM,  <tinnews at 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



More information about the Python-list mailing list