class method `self.desc`

Ruby on Rails 7.0.10

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

self.desc(usage = nil, description = nil, options = {})

Tries to get the description from a USAGE file one folder above the command root.

Parameters

usage opt = nil
description opt = nil
options opt = {}

Source

# File railties/lib/rails/command/base.rb, line 49
        def desc(usage = nil, description = nil, options = {})
          if usage
            super
          else
            @desc ||= ERB.new(File.read(usage_path), trim_mode: "-").result(binding) if usage_path
          end
        end

Defined in railties/lib/rails/command/base.rb line 49 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Rails::Command::Base

Signature

Parameters