On Saturday, March 20, 2004, 4:14:50 AM, Dmitry wrote:
> Hi,
> I tried to start using uri.rb, but it was very difficult, since no docs were
> around.
> So I had to write them by myself, here is my initial attempt to
> document/convert docs
> to rdoc uri.rb from stdlib. Maybe I did something wrong, but it looks much
> nicer to me
> than it was before ;)
> I also did a tab to space conversion, seems that author forgot about it in
> some places.
> I'd be glad to hear any comments or make any changes that will help this
> appear in the CVS.
Thanks for the effort, Dmitri. I'll be looking closely at it shortly,
and it will appear in the CVS in no time :)
Can you just tell me what the patch is *against*? I do all my doc
work against the ruby_1_8 branch, but I have no immediate way of
knowing where your original file came from.
> Also, maybe there are some special tricks or guidelines that I should
> use/follow to create
> a good rdoc documentation?
I'll make some pointers when I have a decent look at it, which is
after I apply the patch, which is after you tell me what to patch it
against :)
I'd love to say "be consistent in style with what's already
documented", but the existing docs are not all that consistent.
Cheers,
Gavin
|
