[Python-Dev] rest markup in ctypes docs
Georg Brandl
g.brandl at gmx.net
Wed Jun 11 21:25:16 CEST 2008
Thomas Heller schrieb:
> Thomas Heller schrieb:
>> There are a few cases where the ctypes docs are rendered incorrectly:
>>
>> http://docs.python.org/dev/library/ctypes.html#function-prototypes
>>
>> This looks as if 'prototype' would be a symbol exposed by ctypes; it is
>> not - it is used as a placeholder for the object returned by calls to
>> the ctypes.CFUNCTYPE, ctypes.WINFUNCTYPE, and ctypes.PYFUNCTYPE functions above.
>>
>> The rest markup is like this:
>>
>>
>> .. function:: prototype(address)
>> :noindex:
>>
>> Returns a foreign function at the specified address.
You can use
.. function:: prototype(address)
:noindex:
:module:
here. (The :module: option gives the function's module name which is empty
in this case.)
>> Some lines below, it looks like ctypes would export '1', '2', and '4'.
>> Here is the markup:
>>
> Sorry, I meant this:
>
> ... data:: 1
> :noindex:
>
> Specifies an input parameter to the function.
A simple definition list or table should suffice here.
Georg
More information about the Python-Dev
mailing list