RDoc Improvement Request

Ruby
1

In searching through the online docs, I noticed that attributes are not
listed in the Methods section to browse for them. Since an attribute is
nothing more than setter/getter methods, I was expecting to find them in
the list.

I’m not 100% that this is RDoc,since I don’t know exactly how the online
docs are created, but I am under the impression that they use RDoc’s
implementation. If I’m wrong, redirect my compass to where I need to
address this.

Thanks
Matt

2

matt wrote:

In searching through the online docs, I noticed that attributes are not
listed in the Methods section to browse for them. Since an attribute is
nothing more than setter/getter methods, I was expecting to find them in
the list.

I’m not 100% that this is RDoc,since I don’t know exactly how the online
docs are created, but I am under the impression that they use RDoc’s
implementation. If I’m wrong, redirect my compass to where I need to
address this.

If methods are defined using attr_* then rdoc does not list them as
methods.

I agree that this is confusing (if not flat out wrong), but I’ve had
this discussion with various people and this view seems to be the
minority.

–
James B.

“If you don’t write it down, it never happened.”

  • (Unknown)
3

On 1/13/07, Felipe N. [email protected] wrote:

address this.
–
(.) CAMPANHA DA FITA ASCII ( http://arc.pasp.de/)
/ \ Contra formatos proprietarios

It is because RDoc parses the actual method definition. Attr_* does
not have the string “\n def * …” or the like in it.

4

On Jan 13, 2007, at 08:37, matt wrote:

docs are created, but I am under the impression that they use RDoc’s
implementation. If I’m wrong, redirect my compass to where I need to
address this.

http://rubyforge.org/tracker/?group_id=627

–
Eric H. - [email protected] - http://blog.segment7.net

I LIT YOUR GEM ON FIRE!

5

On 1/13/07, James B. [email protected] wrote:

If methods are defined using attr_* then rdoc does not list them as methods.

I agree that this is confusing (if not flat out wrong), but I’ve had
this discussion with various people and this view seems to be the minority.

I agree too! Yesterday i send an RDoc to my team partner (very new to
ruby) and she notice this when comparing the UML with Rdoc. This is
very confusing !

6

On Sun, 2007-01-14 at 03:33 +0900, Felipe N. wrote:

address this.

If methods are defined using attr_* then rdoc does not list them as methods.

I agree that this is confusing (if not flat out wrong), but I’ve had
this discussion with various people and this view seems to be the minority.

I agree too! Yesterday i send an RDoc to my team partner (very new to
ruby) and she notice this when comparing the UML with Rdoc. This is
very confusing !

My take was based on the documentation of a method as follows from
Module.attr:

module Mod
attr :size, true
end

is equivalent to:

module Mod
def size
@size
end
def size=(val)
@size = val
end
end

So this implies that the attr* are in fact methods…
but it sounds like this dead horse has been beaten in the past.

Who knows, maybe it’ll finally get to me and I’ll write my own document
parser…

Matt