Qual é o caminho mais rápido para chegar a documentação para Ruby? [fechadas]

Question

dizer que estou a escrever algum código Ruby e eu quero usar o tipo de data padrão para obter a data atual. Em vez de usar um motor de busca, há uma maneira mais rápida de encontrar a documentação para esta classe? Eu sei que posso obter os métodos para Data por Date.methods digitação, mas tanto quanto eu sei que isso não fornece detalhes sobre os tipos de argumento ou valor de retorno.

respostas específicas-Editor são bem-vindas. Meu editor de escolha é Emacs.

Answer 1

Marque o ruby ??docs núcleo

Use comando find-texto de seu navegador.

inesperado que possa parecer, acho que este é realmente mais rápido do que usar ri, que por algum motivo parece ter idade para iniciar.

Também é muito melhor do que ri porque a página HTML listas de toda a documentação para todos os métodos em uma única página. Muitas vezes, os métodos estão relacionados com outros, e alternar entre 2 ri é é doloroso

Answer 2

No seu uso console "ri"

ri Date

que funciona com todas as classes. (Por exemplo, RI String) Para ver a documentação de um método particular de utilizar este:

ri Date#yourMethod

Answer 3

A fonte canônica para documentação Ruby é Rubi-doc - os dois links lá que são dos mais interesse são núcleo e padrão biblioteca. Você obter uma representação de estilo javadoc que normalmente cobre tipos de argumentos e valores de retorno. Você pode até mesmo fazer o seu próprio com RDoc .

Answer 4

Para aqueles de vocês que querem docs de dentro de baunilha IRB

1. Siga estas instruções para configurar o núcleo RI documentação. Como na escrita, os passos são

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

2. Agora você pode ver docs para um método específico na linha de comando usando o comando ri. Para invocá-lo a partir de dentro IRB, use o comando de ajuda:

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