Re: [PATCH] Start fleshing out Repos.pm documentation

[David James <dj...@collab.net>]

On 9/28/06, Nik Clayton <ni...@ngo.org.uk> wrote:
> I've noticed that there are quite a few new APIs missing from the Perl
> bindings.  So I started looking at adding them, and then realised that the
> documentation needed a bit of an overhaul.
>
> Rather than try and do both things at once, I've tried to get the
> documentation in to a slightly more malleable shape first.
>
> So, this first patch just rejigs the internal documentation of Repos.pm, and
> changes the implementation slightly so that as methods are documented (or
> added) it's easier to note that that's happened (IMHO).
>
> [[[
> Add more detail to the documentation for the SVN::Repos Perl bindings
>
> Rearrange how methods are wrapped in this file, to make it easier to add new
> methods in the future while keeping the documentation in sync.
>
> * subversion/bindings/swig/perl/native/Repos.pm:
>   (@methods): Build up the list of exported methods throughout the file,
>   which keeps a method's export point nearer its point of documentation.
>   (POD Documentation): Add documentation for get_logs().  Explicitly list
>   the other methods that are exported.  Bring the example up to date, and
>   update the copyright date.
> ]]]
>

Thanks Nik! Committed in r21741.

Cheers,

David

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: [PATCH] Start fleshing out Repos.pm documentation

[David James <dj...@collab.net>]

On 10/3/06, David Glasser <gl...@mit.edu> wrote:
>   On 9/28/06, Nik Clayton <ni...@ngo.org.uk> wrote:
>   > +my @methods = ();              # List of functions to wrap
>   > +
>   > +push @methods, qw(open create);
>
>   Is this correct?  It looks like this would make $repos->open and
>   $repos->create work, which isn't right, is it?

Good catch, Dave. Fixed in r21744.

Cheers,

David

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: [PATCH] Start fleshing out Repos.pm documentation

[David Glasser <gl...@mit.edu>]

On 10/3/06, David James <dj...@collab.net> wrote:
>
> Thanks Nik! Committed in r21741.

Whoops, looks like this email I sent to Nik wasn't CC'ed to the list:

  On 9/28/06, Nik Clayton <ni...@ngo.org.uk> wrote:
  > +my @methods = ();              # List of functions to wrap
  > +
  > +push @methods, qw(open create);

  Is this correct?  It looks like this would make $repos->open and
  $repos->create work, which isn't right, is it?

... and he agreed.  I'll test to make sure I was right, and remove
that last line.

--dave

-- 
David Glasser | glasser@mit.edu | http://www.davidglasser.net/

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org