Module: Ey::Core::Cli::Helpers::Deprecated::ClassMethods

Defined in:
lib/ey-core/cli/helpers/deprecated.rb

Overview

Class-level helpers pulled into an including class

Instance Method Summary collapse

Instance Method Details

#deprecate(deprecated_title) ⇒ NilClass

A helper for deprecating a Belafonte-based command

Parameters:

  • deprecated_title (String)

    the title of the command

Returns:

  • (NilClass)

    this method is not expected to return a value



16
17
18
19
20
21
22
# File 'lib/ey-core/cli/helpers/deprecated.rb', line 16

def deprecate(deprecated_title)
  title deprecated_title
  summary 'This command has been deprecated'
  description <<-DESCRIPTION
The #{meta[:title]} command has been deprecated. We apologize for any inconvenience.
DESCRIPTION
end