Как быстрее всего получить доступ к документации по Ruby?[закрыто]

Question

Допустим, я пишу Ruby-код и хочу использовать стандартный тип Date для получения текущей даты.Есть ли более быстрый способ найти документацию по этому классу вместо использования поисковой системы?Я знаю, что могу получить методы для Date, набрав Date.methods, но, насколько мне известно, это не дает подробностей о типах аргументов или возвращаемом значении.

Ответы, специфичные для редактора, приветствуются.Мой любимый редактор — Emacs.

Answer 1

Добавьте в закладки основная документация Ruby

Используйте команду find-text вашего веб-браузера.

Как бы неожиданно это ни казалось, я обнаружил, что это на самом деле быстрее, чем использование ri, запуск которого по какой-то причине занимает много времени.

Это также намного лучше, чем ri потому что на странице HTML вся документация по всем методам представлена ​​на одной странице.Часто методы связаны с другими, и переключение между двумя riэто больно

Answer 2

На вашей консоли используйте «ri»

ri Date

Это работает со всеми классами.(например.RI String), чтобы увидеть документацию для конкретного метода, который вы используете:

ri Date#yourMethod

Answer 3

Канонический источник документации Ruby: Руби-док - две ссылки, которые представляют наибольший интерес: основной и стандартная библиотека.Вы получаете представление в стиле Javadoc, которое обычно охватывает типы аргументов и возвращаемые значения.Вы даже можете сделать свой собственный с РДок.

Answer 4

Для тех из вас, кому нужны документы из ванильного IRB

1. Следовать эти инструкции по настройке основной документации RI.На момент написания шаги следующие:

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

2. Теперь вы можете просматривать документацию для определенного метода в командной строке, используя команду ri команда.Чтобы вызвать его из IRB, используйте команду help:

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