Описание тега yard
YARD означает "Ура! Инструмент документации Ruby". Он считается альтернативой инструменту rdoc с большим количеством функций.
2
ответа
Двигатель с использованием postgis
У меня есть экземпляр в Engineyard, и я хочу установить postgis. Я попробовал несколько вещей с шеф-поваром, но безуспешно. Кто-нибудь успешно установил postgis на Engineyard? а можешь рассказать как ты это сделал?
04 фев '11 в 16:36
0
ответов
Тэги произвольной формы, ссылающиеся на другой документ в комментариях YARD?
Мне нужно иметь возможность связывать теги (в частности, вездесущие термины) в документе YARD, полученном из кода Ruby, с определением этого тега во внешнем документе. Было бы удивительно, если бы я мог затем дать перекрестные ссылки на эти ссылки. …
25 ноя '18 в 07:34
2
ответа
Прай дает кучу предупреждений
Требующий pry в моем RSpec spec_helper.rb и запуск моих спецификаций дает мне кучу предупреждений. Как мне избавиться от них? /Library/Ruby/Gems/2.0.0/gems/pry-0.10.0/lib/pry/commands/bang.rb:3: warning: ambiguous first argument; put parentheses or …
10 июн '14 в 06:49
0
ответов
Можно ли сгенерировать документацию типа кукол в машиночитаемом формате?
Документация для типа кукол генерируется автоматически ( https://docs.puppetlabs.com/references/4.2.latest/type.html) с использованием yardoc, я полагаю ( https://github.com/puppetlabs/puppet/blob/master/tasks/yard.rake) Есть ли способ настроить инс…
10 окт '15 в 01:16
2
ответа
Как пересобрать rdoc для всех установленных гемов?
У меня есть несколько драгоценных камней, установленных в нескольких местах. Какой трудный / простой способ генерировать / регенерировать: RDOC для всех этих установленных драгоценных камней, все сразу? yardoc для всех этих установленных камней, все…
30 июн '10 в 19:47
1
ответ
Двор и С расширение
У меня есть расширение C ruby, которое я документирую с помощью rdoc. Существуют как файлы C, так и файлы ruby, которые анализируются с помощью rdoc. Может ли ярд сделать то же самое, и существует ли "легкий путь" (я имею в виду наиболее часто испол…
03 окт '15 в 08:39
1
ответ
YARD - у тега @param неизвестное имя параметра
Я пытаюсь документировать свой код, используя YARDТем не менее, мне трудно понять, как избавиться от следующего предупреждения: $ ~/.gem/ruby/2.3.0/bin/yard [warn]: @param tag has unknown parameter name: val in file `lib/wolfsden_myanimelist/values.…
22 дек '16 в 01:17
0
ответов
Как использовать уценку на Rubydoc.info?
Я документирую драгоценный камень Ruby локально, используя ЯРД. Когда я выпускаю новую версию гема, Rubydoc.info автоматически начинает анализировать новые документы. Проблема в том, что он неправильно обрабатывает мою разметку документации. Что у м…
27 апр '17 в 02:49
2
ответа
Документация по Ruby Yard: как добавить "дословно" (чтобы сгенерировать что-то вроде тега <pre>)
Я хочу, чтобы кусок кода, например хэш, отображался с фиксированной гарнитурой в полученном html. Предположим, это содержимое моего файла: =begin One example of valid hash to this function is: { :name => "Engelbert", :id => 1345 } =end def f h…
24 июл '18 в 10:00
2
ответа
Подсказка или вывод типа возврата для функции RSpec let(), реализующей FactoryGirl create()
Используя RubyMine, в тесте rspec, есть ли способ сообщить RubyMine тип создаваемого объекта (для автозаполнения и подавления предупреждений "не удается найти"? например: # @yieldreturn [Tibbees::Tibbee] let!(:tibbee) { create(:tibbee, canonical_ven…
28 июл '17 в 14:50
1
ответ
Есть ли аналог тега @! Method для методов класса?
Двор имеет метку @!method описать документацию для примеров методов, которые создаются динамически. Есть ли похожий тег для методов класса?
27 май '13 в 10:28
1
ответ
Документирование маршрутов Синатры для расширений (Двор:: Синатра не работает)
Я пишу приложение Sinatra среднего размера, которое разбиваю на расширения, размещенные в./lib/extensions/. Я хочу документировать каждый маршрут, но Yard::Sinatra документирует только маршруты, определенные в основном файле application.rb. Могу ли …
16 янв '11 в 01:35
1
ответ
Двор и ссылки на классы / модули в документе
В настоящее время я переключаюсь с rdoc на ярд для моей документации по программному обеспечению ruby. В моем документе я часто ссылаюсь на некоторые классы / модули из комментариев, например: ## == Provides various utility features ## ## == Feature…
16 сен '10 в 08:55
2
ответа
Как я могу сослаться на параметр (тег @param) из другого параметра?
Я использую Ruby on Rails 3.1.0 и гем YARD 0.7.4 для документации. Я хотел бы сослаться на параметр (@param тег) из другого параметра. То есть у меня есть: # ... # # @param [String] argument_1 # Here I would like to have a description text with a re…
19 янв '12 в 21:50
0
ответов
Полностью замените rdoc на ярд для установки / сервера gem
Есть ли способ полностью заменить rdoc на ярд, даже при установке драгоценного камня? Как сейчас, gem server имеет доступ только к документам, сгенерированным rdoc. В некоторых случаях, таких как FFI-gem, документация пишется с ярдом, пытаясь прочит…
24 янв '13 в 16:34
1
ответ
Создание пользовательских YARD уценки
У меня есть следующий метод, который я хотел бы документировать, используя YARDoc, # Here is my method # @arg woop [Woop] *dangerous* this parameter is output to the screen def shoop(woop) puts woop end Это генерирует HTML где dangerous выделено жир…
11 окт '13 в 02:22
2
ответа
Как создать произвольную ссылку в документации YARD?
Я пытаюсь создать несколько ссылок в моей документации YARD. Я могу получить ссылку HTTP: # I like {http://stackru.com Stackru} отображается как <p>I like <a href="http://stackru.com">Stackru</a></p> Но ссылка на электронную …
18 авг '09 в 13:51
1
ответ
Документирование функции, которая отображает JSON с Yard?
Если у меня есть функция, которая возвращает это: render :json => @orders.as_json(include: [{:user => {only: :id}}], :only => [:id, :status_id]) Я документирую это так: # @return [JSON] includes the id, the order status id and the id of the…
04 июн '14 в 21:58
1
ответ
Вся Ruby документация в автономном режиме со двором
Если я хочу посмотреть документацию по моим драгоценным камням, я могу сделать: yard server --gems Как я могу увидеть документацию стандартной библиотеки Ruby?
01 дек '11 в 19:08
0
ответов
Использование ярда для работы с файлами уценки
Я написал некоторые, используя документацию для рубинового камня. Я использую ярд для создания справочной документации по гемам ruby из источника ruby, и я хочу, чтобы ярд работал с этой другой документацией по уценке. Я написал документацию в git…
10 авг '14 в 18:26