class method self.desc

Ruby on Rails 6.0.6.1

Since v5.1.7

Available in: v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3.2 v8.0.5.1 v8.1.3.1 edge

Signature

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 31
        def desc(usage = nil, description = nil, options = {})
          if usage
            super
          else
            @desc ||= ERB.new(File.read(usage_path)).result(binding) if usage_path
          end
        end

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

Defined in Rails::Command::Base

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close