Geoffrey Young wrote:
That's exactly why I'm asking here. Please commit a better wording, since
it's going to appear on all other manpages with similar issues.


will do

Excellent!


Besides the issue with unsupported methods, the rest looks good to you?



yeah, it looks great!

Thanks.


the only thing I find strange is arg1, which is always the object. while ->
makes $self the first argument to the send() subroutine in the strict perl
sense, from the user standpoint the first argument to the send() method is
really $buf.

Well, the object is really the first argument, since:


$socket->recv($len);

is really:

APR::Socket::recv($socket, $len);

Besides, notice that the actual variable name is listed in the item and even the fact that it's an object, so it says:

* arg1: $socket (APR::Socket object)
* arg2: $len (number)

So the enumeration is really just an added value. May be we can simply drop the numbers...

That's my thinking so far.

However if you think that there is a better way to represent things, please suggest so.

e.g. we could say:

* obj: $socket
* arg1: $len

but once we do that someone might just as well argue that it's confusing to have $len denoted as arg1.

Either way is fine, as long as we keep things consistent.

> so, if possible, I'd prefer to see the docs reflect that.  but
> I realize lots of this is probably autogenerated so it might not be that
> simple.

That's not a problem. All autogenerated methods need manual work anywhere, and many methods weren't picked by Gerald's tool at all. So I have to go through .xs files and make sure that none are missed.

--
__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to