I think this is important - there is reasonable sized group of people
who thing that ruby's greatest weakness is probably its docs, I'm among
them.
Improvements in the docs should hit the web pages as quickly as
possible. Give users of the docs the feeling improvements are being
made, gives submitters of docs the ability to see their new docs right
away.
Quoting jbritt@xxxxxxxxxxxx, on Wed, Mar 09, 2005 at 07:35:08AM -0700:
> Sam Roberts wrote:
> >
> >Is it possible to rebuild the stdlib docs nightly?
>
> I would imagine; the source code would need to be fetched each time. I
> don't know if the layout requires any manual tweaking, though.
Not all the src, just a cvs update, its fast.
I just run the stdlib-doc tools on my local cvs, seems to work fine
without tweaking, and gets me up-to-date docs.
> But I believe a new version is uploaded to ruby-doc whenever the docs
> change, and to my knowledge that was last December.
There have been doc changes since December.
process.c: 1.129 (matz 04-Mar-05) corrects critical misinformation
about #sleep.
Also Tanaka merged my rdoc patch for pp.rb on Mar 6, and resolv.rb has
a new SRV record that is documented. There are other changes, those
are just the ones I know about because I submitted them.
Doc changes don't always show up in log messages (like the 1.129 of
process.c), so if somebody is watching the changelogs and rebuilding
when they see changes, this won't work.
Better to automate, I think.
There could even be a diff afterwords, and if the docs are actually
different push a notice out on an RSS feed, but thats probably asking
too much of volunteers. :-)
Cheers,
Sam
|
