Документация по Ruby 2.4.4 отсутствует - PullRequest
0 голосов
/ 04 июля 2018

Мой вопрос касается документации ruby-doc.org, но также касается поиска документации ri внутри ruby.

Я уже прочитал десятки похожих вопросов / ответов о том, что ри не работает и дает сообщения «ничего не известно», и я пытался следовать некоторым из этих старых советов. Просто кажется, что эти старые ответы не относятся ко мне. Одним из них было установить rdoc --all --ri из корневого каталога ruby. Я попробовал это, и это не удалось (невозможно преобразовать в UTF8 или что-то в этом роде). Другой предположил, что установщик rubyinstaller для Windows просто больше не содержит эту информацию, и я должен использовать онлайн-документацию, которая, когда я захожу на http://ruby -doc.org / downloads / , я обнаруживаю, что версия Я использую (2.4.4) не существует.

Это странно, потому что на сайте rubyinstaller специально сказано, что если я новичок в Ruby (которым я и являюсь), я должен установить 2.4.4. Вы могли бы подумать, что если бы у любой версии была хорошая документация, это была бы та. Вместо этого он, кажется, полностью отсутствует.

Это все началось, потому что я пытаюсь выучить Ruby и наблюдаю за курсом Lynda.com по Ruby Кевина Скоглунда, который был записан много версий назад, и в этом курсе он ссылается на команду ri из оболочки, которая в моем версия не работает. см. ниже:

ruby ​​--version ruby 2.4.4p296 (версия 20101-03-28 63013) [x64-mingw32]

ри - версия ri.cmd 5.0.0

ri String Ничего не известно о String

Теперь, если он не доступен в ruby ​​с использованием ri, и мне нужно использовать онлайн-документацию, и она отсутствует для моей версии, которая, как оказалось, является версией, рекомендованной для новых пользователей,… вы видите мое разочарование.

Вот что я действительно хочу ... 1. Я хочу использовать ри и заставить его работать. 2. Если это просто невозможно, я хотел бы знать, где документация для моей версии онлайн, потому что она не там, где должна быть.

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

1 Ответ

0 голосов
/ 04 июля 2018

Поскольку вы используете RubyInstaller, я предполагаю, что вы работаете в Windows.

Я открою это, сказав, что я не на 100% в этом, но я довольно уверен в этом ответе.

  • «Использовать 2.4, а не 2.5» было связано с ошибками с Ruby Gem, когда Ruby 2.5 был впервые выпущен, так как я случайно оказался на машине с Windows Руби в то время, и это было обоснование на тот момент не использовать новейшую версию 2.5.
  • Вышеупомянутая причина была исправлена.

Реально, если вы новичок, если вы используете документацию, которая близка к вашей версии (2.0+ - 2.4-иш), все будет хорошо. Теперь, очевидно, и я не должен был предоставлять этот отказ от ответственности, хотя я сделаю так, чтобы избежать неизбежных отрицательных голосов, если я этого не сделаю, это не 100% идеальное решение, и будут очень небольшие различия. Как новичок, вероятность того, что вы столкнетесь с каким-либо из этих различий, чрезвычайно низка, достаточно низка, чтобы о ней даже не беспокоиться. В каждом языке отсутствуют и плохо документированы разделы, и Ruby не является исключением. Как правило, это менее используемые классы (хотя Ruby Fiddle - исключение, которое я ненавижу, поскольку оно плохо документировано), и оно не будет влиять на ваш процесс обучения, когда вы изучаете основы и ядро ​​языка.

Насколько я помню, «ядро» довольно хорошо задокументировано, и, если вы используете документацию от 2.0+ (чем ближе к 2,4, тем лучше), у вас все будет в порядке, и это точно так же. «Стандартная библиотека» может быть чуть больше поражена или пропущена, а ваш пробег может немного отличаться, но все равно ничего особенного.

Итак, чтобы ответить на вторую часть вашего вопроса, не беспокойтесь о том, чтобы найти ТОЧНУЮ версию используемой вами документации. Он может даже не существовать в сети, хотя установщик должен был предоставить файл справки CHM (для него будет ярлык с ярлыками для Ruby, IRB и т. Д.

Что касается "почему", ри не работает, я еще не уверен на 100%. Я нахожусь на ArchLinux, а RDoc даже не построен. Честно говоря, RDoc остается на обочине для более нового (и лучшего IMO) механизма документооборота, а именно YARD. Возможное решение, которое я делаю и предпочитаю, - установить гем YARD сразу после установки Ruby:

gem install yard

А затем установите YARD для генерации моей документации с этим в CMD:

yard config --gem-install-yri

Если вы решите пойти по этому пути, об этом можно узнать гораздо больше здесь .

Преимущество в том, что он также поддерживает RDoc и обратно совместим.

...