Ruby эквивалент Python help()?

При работе в интерактивном Python я склонен полагаться на встроенную функцию help(), чтобы сообщить мне, что что-то ожидает и/или возвращает, и распечатать любую документацию, которая могла бы мне помочь. Существует ли Ruby эквивалент этой функции?

Я ищу что-то, что я мог бы использовать в irb. Например, в интерактивном Python я могу ввести:

>>> help(1)

который затем распечатает

Help on int object:

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

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

Ответы

Ответ 1

Это определенно плохой кузен для помощи iPython и одна из основных функций, которые я пропускаю после перехода на Ruby, но вы также можете использовать ri из irb. Я бы рекомендовал жемчужину как простой способ установить это.

Ответ 2

Попробуйте использовать ri из командной строки.

В качестве аргумента требуется имя, метод или модуль класса, а также соответствующая документация. Многие популярные драгоценные камни также поставляются с этой формой документации, поэтому они, как правило, работают даже за пределами основных модулей Ruby.

Ответ 3

Сейчас в конце 2014 года и здесь два способа получить сходство Python help() *, если у вас есть Ruby Docs:

  • Изнутри irb Вы можете вызвать метод help со строкой, описывающей то, что вы ищете.

    Пример 1: help 'Array' для класса Array
    Пример 2: help 'Array#each' для метода Array class each.

  • В командной строке, за пределами irb, вы можете использовать программу ri:

    Пример 1: ri 'Array' для класса Array
    Пример 2: ri 'Array#each' для метода Array class each.

* Не так хорошо, как Python, но все же лучше, чем ничего

Ответ 4

Предполагается, что irb_help. Но, как упоминалось в этом сообщении, он также разбился на мою рубиновую установку.

Ответ 5

Для быстрого доступа к оболочке для рубиновой документации просто введите ri, а затем метод, который вы хотите узнать больше (из вашей оболочки).

Например:

ri puts

Это должно быть запущено в вашей оболочке, а не в irb (интерактивная рубиновая среда)

Если вы находитесь в среде irb, то другой способ - просто набрать справку, за которой следует метод, о котором вы хотите узнать больше:

help puts

Однако это предполагает, что вы правильно настроили среду Ruby для того, чтобы (помощь) корректно работала в irb. Обычно я просто открываю другую оболочку и просто использую ri непосредственно для быстрого доступа, когда я сомневаюсь в некотором методе или аргументах для метода.