[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: API documentation wanted (for Python in particular)

From: Barry Scott <barry_at_barrys-emacs.org>
Date: 2006-03-15 21:32:00 CET

On Mar 13, 2006, at 00:48, Daniel Berlin wrote:

>> Expecting people to read cryptic .h files AND even more cryptic SWIG
>> files is really not very nice at all.
> See, this is where i disagree.
> Expecting people to read well documented .h files to discover what the
> interface for something is, IMHO, is perfectly fine.

A couple of years ago I did not think the SVN API was good for python
and did not think
that the lack of documentation was reasonable either.

That is why I wrote pysvn and critically documented it.

Oh and personally I find that reading the .h is rarely good enough. I
end up reading the .c files
as well to figure out stuff that is not in the .h comments.

Barry
pysvn developer
Received on Wed Mar 15 21:32:50 2006

This is an archived mail posted to the Subversion Users mailing list.