# RDoc (Darkfish) not ordering method by name

**URL:** <https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437>\
**Category:** Ruby\
**Created:** [March 10, 2009, 12:29am UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437 "2009-03-10T00:29:06Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 10, 2009, 12:29am UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/1 "2009-03-10T00:29:06Z")

</div>

Hi, when I run “rdoc” Darkfish creates an HTML in which my class methods  
appear in alphabetic order.  
Is it possible RDoc not to order the methods by name? I would really  
prefer it  
to respect the order in which they are written into the class.

Thanks.

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 10, 2009, 1:59am UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/2 "2009-03-10T01:59:14Z")

</div>

On Mar 9, 2009, at 16:26, Iñaki Baz C. wrote:

> Hi, when I run “rdoc” Darkfish creates an HTML in which my class  
> methods  
> appear in alphabetic order.  
> Is it possible RDoc not to order the methods by name?

It isn’t possible

> I would really prefer it to respect the order in which they are  
> written into the class.

You can group methods by section, but currently Darkfish ignores  
sections. A future release will correct this.

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 12, 2009, 10:06pm UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/3 "2009-03-12T22:06:47Z")

</div>

El Martes, 10 de Marzo de 2009, Eric H.  
escribió:\>

> You can group methods by section, but currently Darkfish ignores  
> sections. A future release will correct this.

Thanks for clarify it.

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 13, 2009, 12:15am UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/4 "2009-03-13T00:15:42Z")

</div>

Eric H. wrote:

> On Mar 9, 2009, at 16:26, Iñaki Baz C. wrote:
> 
> > Is it possible RDoc not to order the methods by name?  
> > It isn’t possible  
> > You can group methods by section, but currently Darkfish ignores  
> > sections. A future release will correct this.

As a kinda- feature request, I re-open the same class in  
various different subsystems, where the subsystems provide  
aspects of the system that can be either required or omitted.  
Perhaps a better solution would be to do that with an include,  
but anyhow… I’d like to be able to separate the features of  
class X that belong to each aspect… is that what sections  
are for? If not, I think it’d be nice if that was somehow  
possible.

With this, I’d like to see the classname and description,  
then a set of aspect/section names, each with a summary  
listing of the method names - each method name to jump into  
a (possibly global-sorted?) list of method descriptions.

Thoughts? Would anyone else use a feature like this?

A similar feature would allow, for example, to have Array  
documentation include links to the Enumerable methods it  
includes. Helpful for someone wanting to learn what an Array  
can do.

Clifford H…

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 13, 2009, 12:39am UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/5 "2009-03-13T00:39:42Z")

</div>

El Viernes, 13 de Marzo de 2009, Clifford H.  
escribió:\> A similar feature would allow, for example, to have Array

> documentation include links to the Enumerable methods it  
> includes. Helpful for someone wanting to learn what an Array  
> can do.

Yes, very useful. For example I’m building a SipUri class which is child  
of  
GenericUri. Lots of methods are just defined for GenericUri and not  
overriden  
in SipUri.  
Unfortunatelly RDoc (Darkfish) doesn’t show non-overriden GenericUri  
methods  
in SipUri documentation. It would be really useful.

---

<div class="post-metadata">

**Author:** ![ISSSSaki\_Baz\_C](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/i/51bf81/32.png) [@ISSSSaki\_Baz\_C](https://www.ruby-forum.com/u/ISSSSaki_Baz_C)\
**Post date:** [March 16, 2009, 7:51pm UTC](https://www.ruby-forum.com/t/rdoc-darkfish-not-ordering-method-by-name/162437/6 "2009-03-16T19:51:04Z")

</div>

On Mar 12, 2009, at 16:12, Clifford H. wrote:

> Perhaps a better solution would be to do that with an include,  
> but anyhow… I’d like to be able to separate the features of  
> class X that belong to each aspect… is that what sections  
> are for? If not, I think it’d be nice if that was somehow  
> possible.

You could use sections for this, yes

> A similar feature would allow, for example, to have Array  
> documentation include links to the Enumerable methods it  
> includes. Helpful for someone wanting to learn what an Array  
> can do.

Darkfish has links to included modules via the sidebar.