From: Robert Dober <robert.dober@...>
Date: 2009-06-23T17:38:30+09:00
Subject: Re: ruby suggestion: officially sanctioned tutorials/howto's

On Tue, Jun 23, 2009 at 5:00 AM, Joel VanderWerf<vjoel@path.berkeley.edu> wrote:
> Robert Dober wrote:
>>
>> I am just a little bit confused about
>> the x::Tutorial, should that not be Tutorial::X
>> for X in { Array, Module, Class, Exception, Enumerator, You::Name::It } ?
>>
>> And Tutorial would be a module in the standard lib?
>
> I had it the other way (Socket::Tutorial etc.) because that would keep the
> tutorial in the namespace of the subject. You could structure a library like
> this:
>
> module M
>  # Give the overall M tutorial here.
>  module Tutorial
>    # Tutorial for feature x
>    def self.feature_x
>    end
>  end
>
>  def self.feature_x
>  end
>
>  # API overview for C
>  class C
>    # Tutorial for C
>    module Tutorial
>    end
>  end
> end
>
> Or maybe it should all be in one global Tutorial space. Dunno...
Why not Joël, I did not really get it. But I guess it all depends on
the tools and implementors.
The only issue I see is with frozen classes, they could not be reopened in a
require 'tutorial/whatver'
right?
But I guess there are no frozen classes in core and stdlib. However it
would be great for third party developers to be able to adopt the
style.

Just my Doller/(42+8)
Cheers
Robert
>
> --
>      vjoel : Joel VanderWerf : path berkeley edu : 510 665 3407
>
>



-- 
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]