On Wednesday, February 4, 2004, 5:42:15 AM, Zachary wrote:
>> >> Today I decided I'd like to help Ruby documentation. I checked the
>> >> status page on ruby-doc.org and saw that ftools needed documentation, so
>> >> I gave it a shot. Since this is my first crack at it, I'm hoping someone
>> >> can review the file and make suggestions for how I should do things
>> >> differently. I'll attach it to this email. Thanks.
>>
>> > Thanks very much for your help, Zachary! At first glance, the
>> > documentation looks excellent. I'm just reviewing it amongst doing
>> > other things, and I'll let you know when I commit it to CVS.
>>
>> I just realised that I have several changes at once, heading towards a
>> 0.9 release, so I can't 'release' ftools doco just yet. Gimme a
>> couple of days. Some of the expressions in the doco are unclear, but
>> that's not your fault; the parameters 'from' and 'to' really make it a
>> mouthful.
> I agree. It took a lot of effort to avoid changing code. The other thing
> I didn't like was how verbose mode was handled. It just looked for
> non-strings, rather than a true value. But I tried to make the
> documentation reflect the actual code and not what I thought the code
> should be.
> The other thing I thought of after I submitted this was, should there be
> a comment about using FileUtils at the file level in ftools? FileUtils
> seems to be much more complete and cleaner, so maybe users should be
> warned?
Already added :)
Gavin
|
