From: Gavin Sinclair <gsinclair@...>
Date: 2002-09-09T00:59:41+09:00
Subject: Re: Document tools


----- Original Message -----
From: <bbense+comp.lang.ruby.Sep.08.02@telemark.stanford.edu>


>
> - - The only advantage POD has over anything existing currently in
> Ruby is that I always know where to find it. If I always know
> where to look and what I'll find there, I can write automated
> tools to search it[1]. POD was the Perl community's answer to
> the question that originally started this thread. All the
> objections to Ruby as a "real" language have been answered
> by both the Perl and Python worlds. It wasn't that long ago
> that having a career as a Perl programmer seemed as remote
> as being a Ruby programmer does now. I'm not suggesting that
> we use POD as anything other than a model for ideas.
>
> - - While Ruby has a document writing tool in rdoc that
> surpasses anything in the Perl world, it doesn't have a
> document FINDING tool that is anywhere near as good as
> perldoc. In the long run I really don't care what format
> the documentation is in as long as I can find it quickly.
>
> - - Booker C. Bense
>

Insofar as any objectives have been formally set by the new effort to make Ruby
documentation more consistent/usable, this aspect - finding doco - is a high
priority.

Regards,
Gavin