What is the RDoc on File talking about?

Ruby
1

This really confused me - why is the RDoc for the file class talking
about ftools.rb right at the top?
http://www.ruby-doc.org/core/classes/File.html Surely the File class is
in the standard library and most people just want to see the
documentation for that.

2

On Tue, Apr 1, 2008 at 7:10 PM, Oliver S.
[email protected] wrote:

This really confused me - why is the RDoc for the file class talking
about ftools.rb right at the top?
class File - RDoc Documentation Surely the File class is
in the standard library and most people just want to see the
documentation for that.

Because right now RDoc puts all File related stuff together, from all
files that modify the class.

3

Because right now RDoc puts all File related stuff together, from all
files that modify the class.

Ahh OK.

I can see it lists the files the RDoc was generated from as “In:” but is
it possible to tell which methods come from where? I’d like to know
which I can use without requiring anything.

4

On Tue, Apr 1, 2008 at 1:04 PM, Phillip G.
[email protected] wrote:

| I can see it lists the files the RDoc was generated from as “In:” but is

This is especially useful in irb.

True. Personally, using IRB, I’m fond of the construction:
puts (foo.methods - Kernel.methods).sort.join(“\t”)

5

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Oliver S. wrote:
|> Because right now RDoc puts all File related stuff together, from all
|> files that modify the class.
|
| Ahh OK.
|
| I can see it lists the files the RDoc was generated from as “In:” but is
| it possible to tell which methods come from where? I’d like to know
| which I can use without requiring anything.

Not in an easy way (you could compare the methods the requiring adds,
though).

The easy way of knowing what methods are at your disposal at any given
time, is #methods with its pal #sort. This is inherited from Object
(IIRC), and you can always uses those to a) find out what methods are
available, and b) sort the output.

This is especially useful in irb.

  • – Phillip G.
    -----BEGIN PGP SIGNATURE-----
    Version: GnuPG v1.4.8 (MingW32)
    Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkfylVgACgkQbtAgaoJTgL/DuQCghvUVEjCMQ0s6wnQyV/YOVXKj
0BUAn1Uol2e+LABVZH24wYxG3vu3Hui+
=3DZJ
-----END PGP SIGNATURE-----