From: Serg Koren <skoren@...>
Date: 2008-02-16T09:13:17+09:00
Subject: RDoc new/initialize discrepency

>

Thanks that makes sense.



>
>
>> PS - Anyone have a good explanation of why RDoc translates initialize
>> methods as 'new'?   Yes I know you instantiate via:   X.new  but why
>> does the method 'initialize'  get documented as method 'new'?   Seems
>> a bit confusing for us newbies.
>
> I assume because initialize only exists to be called on instances
> after the 'new' for the class has created them. I have personally
> never called #initialize directly; it's always through new.
>
> I suppose the idea is that by documenting the method that you actually
> call, you know how to use the method. (Instead of causing new users to
> think that they should write   f = Foo.new; f.initialize( bar, 42 )
>