Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button

Re: Could Ruby-doc be better? -- Proposal for a better system.: msg#00010

Subject: Re: Could Ruby-doc be better? -- Proposal for a better system.
On Wed, 8 Jun 2005, Lothar Scholz wrote:

Hello Hugh,

HS> On Tue, 7 Jun 2005, Lothar Scholz wrote:
Instead we should run a rdoc server and generate documentation on
demand as this allows much better interaction and things like search

HS> [html is universal, static pages easy, downloadable. Dynamic
HS>  give searching... anything else?]

Your fantasy seems to be a little bit limited. I can think about a lot

"There are more things in heaven and earth, H[ugh], than are dreamt
of in your philosophy." :-)

of things for easier use/navigation. Just look in two month at ArachnoRuby as

<url: http://www.ruby-ide.com/ruby/ruby_ide_and_ruby_editor.php >?
nice screenshots, presumably to edit it must be dynamic....

this is what i'm currently working on. As i said the html can't be
static as we have open classes so we must have dynamic generated docs.
Sorry i really don't see any other way.

But doesn't that mean that the docs require the program to be
running?  I don't understand how that works when things go in and
out of scope.

And your arguments are very old fashioned, like response time
and universally useable (is there any ruby platform where webrick does not
run ?). If people can download the tgz they can also start something
like "rdoc -s c:\mypath\to\zip".

I was thinking about the case where people may not have ruby, but
having seen a project they like get Ruby as a pre-requisite.  [In
1990 and before I saw lots of people talking about Perl4 but the
syntax looked rather frightening.  Because we needed it for
FrameMaker I got it and learned about it]  I take your point about
webrick.

Always staying with the least common divisor is not a good idea.

I was thinking about people with 40kBit lines :-)  Actually my
universally useable point comes from accessibility matters.  I heard
that the pager (now obsoleted by texting) was originally designed
for deaf people.  Text browsers facilitate usage over slow links.
Etc.

And we always can also provide a dumb static html collection.

OK.

        Thank you
        Hugh




<Prev in Thread] Current Thread [Next in Thread>