2015-07-28 2 views
0

В python в интерактивной консоли, как ipython, я могу просто набрать? и получить документацию практически в любой библиотеке или функции.Где рубиновая документация для драгоценных камней?

Как это сделать в рубине? Я использую pry или irb. Я не могу найти много полезной документации вообще.

Я пытаюсь использовать Фарадей, но набрав ri Faraday не дает никакой документации. Ввод строки ri предоставляет документацию для String, но драгоценные камни, подобные faraday, не содержат никакой документации.

Что я делаю неправильно?

+0

Немного путайте, как вопрос о проблемах с установкой рубиновой документации не соответствует теме для сайта программирования ... Я не прошу никому рекомендовать что-либо, я спрашиваю, почему мой рубиновая документация, похоже, не работала, и благодаря комментариям ниже мне удалось разобраться с моей проблемой ... – Riina

ответ

1

Если вы установили драгоценный камень, используя gem install --ri faraday, тогда вам будет подготовлена ​​документация ri.

Это должно быть значение по умолчанию, но поскольку генерация Ri doc может занять некоторое время, многие люди отключают его, помещая строку в ~/.gemrc, говоря gem: --no-ri --no-rdoc (предоставляя эти параметры в качестве значений по умолчанию для команды gem).

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

+0

В этом была проблема: 'gem: - -no-ri --no-rdoc' был в моем '~/.gemrc' – Riina

1

Если вы хотите прочитать, что документ, Вы можете запустить

gem server 

Это создаст веб-сервис в вашем хосте на порту 8808, с которым вы сможете получить доступ через браузер.

Если вы хотите увидеть, где именно расположена информация, запустите gem env, вы увидите все пути в раздел GEM PATHS.

камень окр

RubyGems Environment: 
.......2.2.2/etc 
    - RUBYGEMS PLATFORMS: 
    ..... 
    - GEM PATHS: 
    - /home/hbranciforte/.rvm/gems/ruby-2.2.2 
    - /home/hbranciforte/.rvm/gems/[email protected] 
    - GEM CONFIGURATION: 
    ..... 
    - REMOTE SOURCES: 
    - https://rubygems.org/ 
    - SHELL PATH: 
..... 

, и если вы посмотрите на ваши GEM ТРАЕКТОРИЙ вы найдете папку с именем док.

[email protected]:gems/ruby-2.2.2 $ cd /home/hbranciforte/.rvm/gems/ruby-2.2.2 
[email protected]:gems/ruby-2.2.2 $ ls 
bin build_info cache doc environment extensions gems specifications wrappers 

Иногда (почти обычно я) запустить свой проект с расслоением --path пачкой/поставщиком

Это создает расслоение папки/поставщик, где он будет хранить ваши драгоценные камни и не хранит документ (т.е. делает bundler намного быстрее, чем установка gem)

Смежные вопросы