software - Cómo obtener la documentación de Ruby desde la línea de comandos

ruby tutorial

Question

Esta pregunta ya tiene una respuesta aquí:

• ¿Por qué mi herramienta Ruby ''ri'' no devuelve resultados en el símbolo del sistema? [duplicar] 1 respuesta

¿Hay alguna manera de averiguar qué parte de mi comando ri no muestra la documentación de Ruby?

 $ ruby --version
 ruby 1.9.3p392 (2013-02-22 revision 39386) [i686-linux]

 $ ri --version
 ri 3.12.2     

 $ ri String
 Nothing known about String

Cuando uso la palanca

 $ pry --version
 Pry version 0.9.12 on Ruby 1.9.3

 $ pry 
 [1] pry(main)> ri String
 # shows String documentation
 [2] pry(main)> ri String.split
 error: ''String.split'' not found
 [3] pry(main)> ri String.strip
 String.strip not found, maybe you meant:
 String#strip_heredoc

¿Qué debo hacer para que aparezca la documentación?

Answer 1

Cuando uso la palanca

$ pry --version
Pry version 0.9.12 on Ruby 1.9.3

$ pry 
[1] pry(main)> ri String
# shows String documentation
[2] pry(main)> ri String.split
error: ''String.split'' not found
[3] pry(main)> ri String.strip
String.strip not found, maybe you meant:
String#strip_heredoc

¿Qué debo hacer para que aparezca la documentación?

Bueno, no hay métodos String.split o String.strip . Sin embargo, hay métodos String#split y String#strip . Trate de preguntar por ellos, y probablemente obtendrá su documentación.

Answer 2

Con la palanca, es mejor instalar la gema pry-doc y luego usar el comando show-doc :

[17] pry(main)> show-doc String#inspect

From: string.c (C Method):
Owner: String
Visibility: public
Signature: inspect()
Number of lines: 6

Returns a printable version of _str_, surrounded by quote marks,
with special characters escaped.

   str = "hello"
   str[3] = "/b"
   str.inspect       #=> "/"hel//bo/""
[18] pry(main)> show-doc Array#pop

From: array.c (C Method):
Owner: Array
Visibility: public
Signature: pop(*arg1)
Number of lines: 11

Removes the last element from self and returns it, or
nil if the array is empty.

If a number n is given, returns an array of the last n elements
(or less) just like array.slice!(-n, n) does. See also
Array#push for the opposite effect.

   a = [ "a", "b", "c", "d" ]
   a.pop     #=> "d"
   a.pop(2)  #=> ["b", "c"]
   a         #=> ["a"]
[19] pry(main)> 

Nota: también puedes usar el ? alias para show-doc si lo prefiere.

Answer 3

Si está utilizando RVM para administrar sus instalaciones de Ruby, puede hacer esto:

rvm docs generate

Si no, trata de hacer esto:

gem install rdoc-data
rdoc-data --install

luego intente el comando ri nuevo.

Answer 4

Usted mencionó en un comentario que está usando el paquete Ruby del administrador de paquetes de archlinux. Lo que necesitas para ri es instalar el paquete ruby-docs :

$ pacman -S ruby-docs

Supongo que separan los paquetes para que las personas que no quieren los documentos puedan ahorrar en el uso del disco.