¿Cuál es la forma más rápida de acceder a la documentación de Ruby? [cerrado]

Question

Diga que estoy escribiendo un código ruby ??y quiero usar el tipo de fecha estándar para obtener la fecha actual. En lugar de utilizar un motor de búsqueda, ¿hay una manera más rápida de encontrar la documentación para esta clase? Sé que puedo obtener los métodos para Fecha escribiendo Date.methods , pero hasta donde sé, esto no proporciona detalles sobre los tipos de argumentos o el valor de retorno.

Las respuestas específicas del editor son bienvenidas. Mi editor de elección es Emacs.

Answer 1

Marca los ruby ??core docs

Use el comando de búsqueda de texto de su navegador web.

Por inesperado que pueda parecer, encuentro que esto es realmente más rápido que usar ri , que por alguna razón parece tardar años en iniciarse.

También es mucho mejor que ri porque la página HTML enumera toda la documentación de todos los métodos en una sola página. A menudo, los métodos están relacionados con otros, y cambiar entre 2 ri es doloroso

Answer 2

En tu consola usa " ri "

ri Date

Eso funciona con todas las clases. (por ejemplo, ri String) Para ver la documentación de un método en particular, use esto:

ri Date#yourMethod

Answer 3

La fuente canónica de la documentación de Ruby es Ruby-doc : los dos enlaces que hay de los más los intereses son core y biblioteca estándar . Obtienes una representación de estilo javadoc que generalmente cubre tipos de argumentos y valores de retorno. Incluso puedes hacer el tuyo propio con RDoc .

Answer 4

Para aquellos de ustedes que quieren documentos desde el IRB de vainilla

1. Siga estas instrucciones para configurar el RI principal documentación. A partir de la escritura, los pasos son

   $ cd ~/.rvm/src
   $ rvm docs generate-ri
   

2. Ahora puede ver los documentos de un método específico en la línea de comandos utilizando el comando ri . Para invocarlo desde IRB, use el comando de ayuda:

   $ irb
   irb(main):001:0> help 'String#chomp'