Можно ли задокументировать задачу Rake с многострочным использованием, доступным из командной строки? - PullRequest
Новая
       47

Можно ли задокументировать задачу Rake с многострочным использованием, доступным из командной строки?

1 голос
/ 09 апреля 2020

Rake позволяет кратко документировать, какие задачи выполняются. Но что, если задача предназначена предоставить больше информации о ее использовании? Вот наивная попытка сделать это с помощью мультилинии desc

desc <<~lid
  Do nothing, even when arguments are provided.
  Usage:
    rake 'users:idle["something", "anotherthing"]'
    rake 'users:idle[, "anotherthing"]' # something is ignored anyway
    rake users:idle # do nothing tersely
lid
task :idle, [:option, :token] => :environment  do |task, fad|
  # Really, do nothing!
end

Но выполнение rake --tasks покажет только первую строку. Есть ли способ получить доступ к остальной части desc с помощью некоторой команды rake?

...