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

Re: Perl bindings docstrings Re: svn commit: r1488693 - /subversion/trunk/subversion/bindings/swig/perl/native/Client.pm

From: Ben Reser <ben_at_reser.org>
Date: Mon, 8 Jul 2013 08:32:14 -0700

On Mon, Jul 8, 2013 at 7:27 AM, Roderich Schupp
<roderich.schupp_at_gmail.com> wrote:
> I'll have a look at how the Perl bindings for Gtk+ do this
> (http://gtk2-perl.sourceforge.net/) Does anybody know of other examples?
> On the other hand, there's not a one-to-one correspondence of
> Perl vs C level parameters, e.g.:
> - editor (or callback) + baton pairs in C are replaced by
> a single Perl callback (typically a closure) in Perl
> - svn_opt_revision_t arguments in C may be actually
> specified as numbers, strings ("HEAD"), date strings ("{12-04-2013}")
> or (unlikely) as _p_svn_opt_revision_t objects in Perl
> So it's as simple as "extract docstring from C header and reformat as POD".

Exactly this. We need this documentation. Sometimes we're behind on
producing it, but once produced it's rarely ever wrong. There is no
way for a Perl user to know how we've wrapped things from the C API.
So in short, suggesting that we remove this documentation or produce
it in some automated way is probably going to produce far worse

Unless someone has invented real AI I just don't see how you can automate this.
Received on 2013-07-08 17:32:53 CEST

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