Как я могу определить разделы без === заголовков для RDoc :: using ()?
Вопрос
Мне нравится создавать справочные страницы, используя вывод '--help' через help2man и txt2man. Система RDoc в Ruby очень удобна, но я не могу настроить использование RDoc :: именно так, как мне нужно. Вот пример сценария:
#!/usr/bin/env ruby
#
# === Name
#
# foobar - Example command for StackOverflow question
#
# === Synopsis
#
# Usage: foobar [--help]
#
# === Options
#
# --help This help message
require 'rdoc/usage'
RDoc::usage('name', 'synopsis', 'options')
Вывод скрипта выглядит следующим образом:
Name
foobar - Example command for StackOverflow question
Synopsis
Usage: foobar [--help]
Options
--help This help message
Но я бы хотел исключить " Имя " и "Синопсис" заголовки для моего вывода об использовании, но все же помечают их как разделы для вывода на страницу руководства.
Использование разметки ': section:' работает для RDoc :: Rdoc, но не для использования RDoc ::. Есть ли очевидный способ пометить разделы для use.rb без печати заголовков?
Решение
Посмотрите исходный код для < код> RDoc :: usage_no_exit код> ; у вас есть два способа подключиться к этому, чтобы достичь желаемого:
<Ол> ENV ['RI']
для принудительного применения различных параметров форматирования (включая указание пользовательского класса форматера) или Переопределите RI :: TextFormatter по умолчанию display_heading (и / или другие методы), чтобы (не) отображать заголовки или что-либо еще
require 'rdoc/usage'
require 'rdoc/ri/ri_formatter'
module RI
class TextFormatter
def display_heading
# nop
end
end
end
RDoc::usage('name')