On Wednesday 24 March 2004 18:11, Gavin Sinclair wrote:
> On Saturday, March 20, 2004, 4:14:50 AM, Dmitry wrote:
> > Here is my initial attempt to document/convert docs to rdoc uri.rb
> > from stdlib.
>
> I'm comitting them as-is, but I'll make some comments below.
Cool
> 1. The URI module should be documented with some background and
> examples. This is a good place to provide a roadmap, enabling
> readers to see some structure and purpose amonst the mess of
> classes.
In TODO now
> 2. There's little or no need to give the methods the full "synopsis,
> args, description, usage" treatment, although it does look
> professional :) The drawback is that it takes up a lot of space. But
> still, full credit for providing lots of information.
I did think about that, but looked in the Logger.rb and saw there that style.
Now I know how to do it ;)
> Still, in some cases, like URI.join, the description doesn't have
> enough detail.
My fault
> 3. There are a few English and formatting errors which I'll correct
> when I have time.
Thanks!
> This is not a criticism!
Why not? I'd be glad to hear it :-)
> 4. In URI::HTTP, I'll remove the "Description" headings as they are
> too prominent in the output, and are redundant, anyway.
Ok :)
> All in all, a fantastic base to build upon.
Thanks, one Q.
As I continue working with uri.rb will you accept any other patches with docs
for it?
As I see now, probably I could make it more comprehensive.
> Thanks,
> Gavin
--
sdmitry -=- Dmitry V. Sabanin
MuraveyLabs.
Spam Here -> postmaster@xxxxxxx
|
