Ruby equivalente a la ayuda de Python()?

Question

Cuando trabajo en Python interactivo, tiendo a confiar en la función incorporada help() para decirme qué es lo que algo espera y/o lo que devuelve, e imprimir cualquier documentación que pueda ayudarme. ¿Hay un Ruby equivalente a esta función?

Estoy buscando algo que pueda usar en irb. Por ejemplo, en Python interactiva que podía escribir:

>>> help(1) 

que luego imprimir

Help on int object: 

class int(object) | int(x[, base]) 
-> integer | | 

Convert a string or number to an integer, if possible. A ... 

Answer 1

Definitivamente es un primo pobre de la ayuda de iPython, y una de las principales características que extraño después de mudarme a Ruby, pero también puedes usar ri desde irb. Recomiendo el wirble gem como una manera fácil de configurar esto.

Answer 2

Try using ri from the command line.

Se necesita un nombre de clase, método o módulo como un argumento, y le da documentación apropiada. Muchas gemas populares también vienen con esta forma de documentación, por lo que debería funcionar incluso más allá del alcance de los módulos básicos de Ruby.

Answer 3

Se supone que es irb_help. Pero como mencioné en esa publicación, también está roto en mi instalación de ruby.

Answer 4

Es ahora a finales de 2014 y aquí están los dos maneras de obtener el * similitud Python help(), siempre y cuando usted tiene la Ruby Docs instalado:

1. Desde el interior irb, usted puede llamar al método help con una cadena describiendo lo que estás buscando.

   Ejemplo 1: help 'Array' para la clase Array
   Ejemplo 2: help 'Array#each' para la each método Array clase.

2. Desde la línea de comandos, fuera de irb, puede utilizar el programa ri:

   Ejemplo 1: ri 'Array' para la clase Array
   Ejemplo 2: ri 'Array#each' para la each método Array clase.

* No es tan bueno como Python, pero mejor que nada

Answer 5

Para el acceso shell rápida al rubí documentación, sólo tiene que escribir ri seguido por el método que está queriendo aprender más acerca (de su cáscara).

Por ejemplo:

ri puts

Esto se debe cocer en su cáscara, no su IRB (rubí entorno interactivo)

Si se encuentra en el entorno de IRB, a continuación, de otro modo, es simplemente escribir help seguido del método que desea aprender más acerca de la siguiente manera:

help puts 

Sin embargo, esto supone que usted h ha configurado correctamente su entorno Ruby para que (ayuda) funcione correctamente dentro de irb. Por lo general, solo tengo otro shell abierto, y simplemente uso el ri directamente para un acceso rápido cuando tengo dudas sobre cierto método o argumentos para un método.