Ri for stdlib

Ruby
1

Hi group.

I installed stable release of ruby ‘ruby 1.8.4 (2006-03-29)
[i686-linux]’ in my linux box. But, when I try to run ri on stdlib, say
Socket, it says ‘Nothing known about Socket.’ Running ‘ri Resolv’
resulted in the same message.

I’ve searched this list, but I couldn’t find any solution but for one
that recommends ‘ruby-doc.org’ which, unfortunately, does not contain
documentation for resolv.rb.

So, I loaded the source code of resolv.rb in vim and read the code and
comments. Is this the best we can do? Is there no way to see
documentaiton for stdlib conveniently?

Sincerely,
Minkoo S.

2

change the current directory to the source directory of ruby
distribution,
and then

rdoc lib/**/*.rb

3

Thanks Eric.

I’ve tried the command, but I failed primarily because there’s no such
things like ‘socket.rb’ Socket is written in C, I guess. So there’s no
document. The same situation in resolv.rb. At this time, resolv.rb does
not contain RDoc documents.

So, does all people in this group examine source codes of Ruby whenever
they want to do something serious with stdlib?

Sincerely,
Minkoo S.

4

Minkoo S. wrote:

So, does all people in this group examine source codes of Ruby whenever
they want to do something serious with stdlib?

Some people take the time to create rdoc for undocumented libraries and
contribute it to the community.

5

Tim. Please don’t be nervous. I am just curious what I’m doing is the
best way of finding documents.

Yes. I know that some people, like the ones at ruby-doc.org, are doing
lots of stuffs for documenting ruby and
I appreciate their effort. As for me, I’m already doing some
translations and posting articles in
Korean ruby community to attract more programmers into the realm of
Ruby.

Anyway, what you’ve said seem to confirm that there’s no solid
documentation available for stdlib.
Well. Disappointed a little bit.

Sincerely,
Minkoo S.

6

On Mar 30, 2006, at 11:53 PM, Minkoo S. wrote:

Hi group.

I installed stable release of ruby ‘ruby 1.8.4 (2006-03-29)
[i686-linux]’ in my linux box. But, when I try to run ri on stdlib,
say
Socket, it says ‘Nothing known about Socket.’ Running ‘ri Resolv’
resulted in the same message.

There is no RDoc for Resolv in 1.8. Only in HEAD.

It seems that Socket is not fully RDoc’d in 1.8. I didn’t check HEAD.

–
Eric H. - [email protected] - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com