Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rdoc/ri/ri_display.rb


Class/Module Index [+]



This is a kind of ‘flag’ module. If you want to write your own ‘ri’ display module (perhaps because you’r writing an IDE or somesuch beast), you simply write a class which implements the various ‘display’ methods in ‘DefaultDisplay’, and include the ‘RiDisplay’ module in that class.

To access your class from the command line, you can do

ruby -r <your source file>  ../ri ....

If folks really want to do this from the command line, I’ll build an option in

Public Class Methods

append_features(display_class) click to toggle source
               # File rdoc/ri/ri_display.rb, line 22
def RiDisplay.append_features(display_class)
  @@display_class = display_class
new(*args) click to toggle source
               # File rdoc/ri/ri_display.rb, line 26
def RiDisplay.new(*args)

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.