From: Gavin Sinclair <gsinclair@...>
Date: 2003-01-28T06:54:52+09:00
Subject: Re: My last word on aliases ;)

On Tuesday, January 28, 2003, 3:57:04 AM, Matt wrote:

> Gavin Sinclair <gsinclair@soyabean.com.au> writes:

>> when I view the RDoc for a large module like FileUtils, it's a bit
>> of a forest/trees scenario.

> Yes I've been thinking about an RDoc feature that allows the
> programmer to organize the method list into functional groups.

> E.g. I now have a class with 60 methods, but they divide up into nice
> groups of functionality.  The RDoc output is currently a flat list of
> methods so this structure is not immediately evident to the reader and
> the class appears more complex than it really is.

Sounds like you want some more classes.

> This would solve the 'alias' problem too, since you could put all the
> aliases at the end under a "method aliases" section.

I don't believe that grouping aliases is logical, because an alias is
logically the same as a method, and should be found as such.  My
initial suggestion was for aliases to appear just before the target,
like in Ruby in a Nutshell.  Dave rejected this because he wants to
maintain a different ordering - perhaps alphabetical.

Gavin