From: Joel VanderWerf <vjoel@...>
Date: 2009-06-23T12:00:47+09:00
Subject: Re: ruby suggestion: officially sanctioned tutorials/howto's

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

-- 
       vjoel : Joel VanderWerf : path berkeley edu : 510 665 3407