classification
Title: ctypes documentation not effective
Type: performance Stage:
Components: Documentation Versions: Python 3.0, Python 2.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: georg.brandl, janssen, theller
Priority: normal Keywords:

Created on 2008-05-06 16:38 by janssen, last changed 2009-04-24 18:14 by theller.

Messages (2)
msg66319 - (view) Author: Bill Janssen (janssen) * (Python committer) Date: 2008-05-06 16:38
Once again I'm reading through the ctypes documentation and finding it
wildly confusing/contradictory.  For instance, there's no discussion of
how ctypes types interact with malloc and free.  The tutorial section is
discursive and rambling.  The type "c_size_t" isn't mentioned in the
section labelled "Fundamental Data Types", but does show up in another
section also labelled "Fundamental Data Types".  The "reference" doesn't
document the use of pointers or arrays.  I find it hard to see how
anyone who doesn't read the ctypes code (several times) could find out
how to use it from the documentation.

I'd suggest getting rid of the Tutorial section, moving it to a
standalone document somewhere, and finishing the writing of the
Reference section.  Adding a chapter discussing when to use ctypes and
when to use the C API might also be a good idea.
msg86421 - (view) Author: Thomas Heller (theller) * (Python committer) Date: 2009-04-24 18:14
Unassigning; myself I will not rewrite the ctypes docs.
History
Date User Action Args
2009-04-24 18:14:42thellersetassignee: theller ->
messages: + msg86421
2008-05-06 16:46:43georg.brandlsetassignee: georg.brandl -> theller
nosy: + theller
2008-05-06 16:38:37janssencreate