Quel est le moyen le plus rapide d’obtenir de la documentation pour Ruby? [fermé]

Question

Disons que j'écris du code ruby ??et que je veux utiliser le type Date standard pour obtenir la date actuelle. Au lieu d'utiliser un moteur de recherche, existe-t-il un moyen plus rapide de trouver la documentation de cette classe? Je sais que je peux obtenir les méthodes pour Date en tapant Date.methods , mais pour autant que je sache, cela ne fournit pas de détails sur les types d'argument ni la valeur renvoyée.

Les réponses spécifiques à l'éditeur sont les bienvenues. Mon éditeur préféré est Emacs.

Answer 1

Ajoutez des signets aux documents de base ruby ??

.

Utilisez la commande find-text de votre navigateur Web.

Aussi inattendu que cela puisse paraître, j’ai trouvé que c’était plus rapide que d’utiliser ri , qui, pour une raison quelconque, semble prendre un certain temps à démarrer.

Il est également bien meilleur que ri car la page HTML répertorie toute la documentation de toutes les méthodes sur une seule page. Les méthodes sont souvent liées aux autres et il est pénible de basculer entre 2 ri

Answer 2

Sur votre console, utilisez "ri"

ri Date

Cela fonctionne avec toutes les classes. (par exemple, ri String) Pour voir la documentation d'une méthode particulière, vous utilisez ceci:

ri Date#yourMethod

Answer 3

La source canonique de la documentation Ruby est Ruby-doc , les deux liens les plus utiles. Les centres d'intérêt sont core et bibliothèque standard . Vous obtenez une représentation de type javadoc qui couvre généralement les types d'argument et les valeurs renvoyées. Vous pouvez même créer le vôtre avec RDoc .

Answer 4

Pour ceux d'entre vous qui recherchent des documents dans IRB vanilla

1. Suivez les ces instructions pour configurer le RI principal. Documentation. Au moment de l'écriture, les étapes sont

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

2. Vous pouvez maintenant afficher les documents d'une méthode spécifique sur la ligne de commande à l'aide de la commande ri . Pour l'appeler depuis IRB, utilisez la commande help:

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