From: Hugh Sasse Staff Elec Eng <hgs@...>
Date: 2003-01-15T09:14:41+09:00
Subject: Re: drb documentation exists?

On Wed, 15 Jan 2003, pat zes wrote:

> i am searching for a drb ([...])
> documentation/reference/guide in english...
>
> all i found by now is:
>
> - the very basic example in "programming ruby" [...]
> - chadfowler.com [...]
> - hugh sasse
>    http://www.eng.cse.dmu.ac.uk/~hgs/ruby/dRuby/
> [...]. the third link seems to be for
> people who learn by codeinsight - i hardly can -> i'm not that familiar with

Is that "code in sight" or "code insight"?  Sorry about that being
inadequate, it is vey much a work in progress.  I found {The Ruby
Deveoper's Guide -- Robert Feldt, Lyle Johnson, Michael Neumann,
published by Syngress ISBN 1-928994-64-4} a big help in
understanding that which I understand now.  But I don't really have
an understanding that I would call "deep" yet. (This is no
disrespect to the other documentors, whose work meets their intended
goals well).  The examples in the drb sources, and the other
resources you mention also helped significantly.

My document aims to provide, when near completion, a better picture
of the relationships between the various classes than that which I
have found otherwise.  Of course, RDoc is a big help here too.
Whether I reach that goal remains to be seen.  In fact, this page is
basically my own notes about this, which I make available publicly.

> ruby.
>
> isn't there something like a list of all (or the most needed)
> classes/functions with their purpose, parameters and returnvalues
> described?

That is more or less what I'm trying to build.  If you have concrete
suggestions for improvements, or even better, patches :-), then I'm
willing to accept them.   It is the semantic part, the purpose,
that is the hard part to document, but this is true for all code,
really, it is the essence of reading other people's code.

>
> ANY help much appreciated - thx,
> pat
>
        Hugh