20 gennaio 2010

Ottenere la documentazione di classi e metodi di Ruby da command line

Poiché uso spesso la documentazione on-line di Ruby e Rails, invece di quella da riga di comando, scrivo questo post come promemoria personale.
Per ottenere la documentazione di Ruby (e quindi anche di Rails e di altre Gem installate in locale) prodotta da rdoc bisogna, stranamente, utilizzare il comando ri, così:
[me@mypc]$ri String

In questo modo otterremo la documentazione prodotta tramite rdoc per la classe String.
Ricordo, inoltre, che il parametro del comando è case-sensitive, per cui c'è differenza fra
[me@mypc]$ri String
e
[me@mypc]$ri string

(in particolare, in Ruby con la maiuscola si fa riferimento ad una classe e con la minuscola ad un metodo, e così assume anche ri/rdoc.



Powered by ScribeFire.


Continua...