[capi-sig] Documenting a C/Py API

Carsten Haese carsten at uniqsys.com
Mon Jul 2 16:22:05 CEST 2007

On Mon, 2007-07-02 at 23:30 +1000, Campbell Barton wrote:
> However Id be interested to know how other projects deal with the issue 
> of maintaining docstrings and online docs.

I maintain separate docstrings and online docs for one simple reason:
The online docs can be more extensive than docstrings. Docstrings are
for brief memory-joggers. Online documentation can contain examples and
generally more detail that's not appropriate for docstrings.

Just my two cents,

Carsten Haese

More information about the capi-sig mailing list