From: Robert Dober <robert.dober@...>
Date: 2009-06-24T06:08:19+09:00
Subject: Re: ruby suggestion: officially sanctioned tutorials/howto's

On Tue, Jun 23, 2009 at 9:11 PM, Joel VanderWerf<vjoel@path.berkeley.edu> wrote:
> Eric Hodel wrote:
>>
>> Why can't the tutorial go on Socket, or Socket.open?  Net::HTTP has it's
>> tutorials on Net::HTTP...
>
> If every class were so well documented, the subject of this thread probably
> wouldn't come up :(
>
> Still, I can imagine wanting 'ri Net::HTTP' to output a short summary of the
> api, rather than a full tutorial, which would be accessible by some other
> command.
Exactly, the purpose of inline documentation is to give a reference
for quick checkup IMHO. I would not like to go through the whole
tutorial everytime. Now one could imagine to have rdoc generate both,
but I feel that this is better done in a different file.
Cheers
Rober
-- 
Toutes les grandes personnes ont d’abord été des enfants, mais peu
d’entre elles s’en souviennent.

All adults have been children first, but not many remember.

[Antoine de Saint-Exupéry]