class method `self.desc`

Ruby on Rails 8.1.2

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 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(description = nil)

Tries to get the description from a USAGE file one folder above the source root otherwise uses a default description.

Parameters

description opt = nil

Source

# File railties/lib/rails/generators/base.rb, line 41
      def self.desc(description = nil)
        return super if description

        @desc ||= if usage_path
          ERB.new(File.read(usage_path)).result(binding)
        else
          "Description:\n    Create #{base_name.humanize.downcase} files for #{generator_name} generator."
        end
      end

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

Defined in Rails::Generators::Base

Signature

Parameters