[#2367] Standard libraries — Dave Thomas <dave@...>

From ruby-dev summary:

60 messages 2004/02/11

[#2397] PATCH: deprecate cgi-lib, getopts, importenv, parsearg from standard library — Gavin Sinclair <gsinclair@...>

Index: cgi-lib.rb

15 messages 2004/02/12

[#2465] PATCH: OpenStruct#initialize to yield self — Gavin Sinclair <gsinclair@...>

This is a common approach I use to object initialization; I don't know

24 messages 2004/02/19

Re: Standard libraries

From: Gavin Sinclair <gsinclair@...>
Date: 2004-02-12 09:37:06 UTC
List: ruby-core #2393
On Thursday, February 12, 2004, 8:18:32 PM, Mauricio wrote:

> On Thu, Feb 12, 2004 at 02:58:22PM +0900, NAKAMURA, Hiroshi wrote:
>> > > Anyway, duplication of something I don't like to see/maintain.
>> > 
>> > I'm still not sure what you think is being duplicated.
>> 
>> For example, a documentation of current CSV.open is as follows.
>>
> [...]
>> 
>> When I want to do refactoring such as param name change
>> (filename -> file_name), or to change disabling 'wb' as a value,
>> I must change the code and the document, too.  It's not fun for me.

> Isn't this precisely the point of using RDoc? Helping (forcing?) the
> maintainer keep the documentation up-to-date? If you just don't want to
> see/maintain documentation no tool can help you; moving the docs somewhere
> else is but a way to deny the problem and let them become obsolete.

Besides, interfaces don't change often, after the software is a little
mature.  Method signatures of *implementation* (private, or in non
user-interface classes) are often refactored, but they don't need
detailed documentation.

Gavin


In This Thread