What is the difference between ri and rdoc

ruby rdoc ri
thenengah picture thenengah · Sep 4, 2010 · Viewed 9.2k times · Source

Whenever I install gems I see ri and rdoc follow. I know this is documentation but what is the difference between the two and how to use them?

Answer

Esselans picture Esselans · Sep 4, 2010

RDoc [..] is the embedded documentation generator for the Ruby programming language. [..] RDoc is included as part of the Ruby core distribution.

RDoc also provides the engine for creating Ruby ri data files. ri is (more or less) Ruby's version of man pages, serving up API information from the command line.

From: http://en.wikipedia.org/wiki/RDoc

Related questions

Why does my Ruby 'ri' tool not return results in command prompt?

Possible Duplicate: ruby 1.9 ri problem When I try to use Ruby's ri tool in a command prompt window to get help about classes, methods, etc. it seems to always fail. For example if I type: ri Array I get a …

Read More
Is there a good, solid reference for proper RDoc syntax?

I'm looking for a good, solid reference for proper RDoc syntax. Recommendations? I can't seem to find anything that clearly shows: How to document class methods and their parameters How to document what a class or class method does.

Read More
How do I generate RDOC for (all of) Rails?

I can do sudo gem rdoc activerecord --no-ri and sudo gem rdoc actionpack --no-ri both of which give me good docs. But sudo gem rdoc rails --no-ri gives me pretty much nothing, as the Rails gem itself is really just …

Read More