Sha256: 2eb125e7c2e7ec417e24a45b11ff742706053400b00e56f817d24aa6e1178681

Contents?: true

Size: 711 Bytes

Versions: 6

Compression:

Stored size: 711 Bytes

Contents

module Commander
  
  ##
  # = Help Formatter
  #
  # Commander's help formatters control the output when
  # either the help command, or --help switch are called.
  # The default formatter is Commander::HelpFormatter::Terminal.
  
  module HelpFormatter
    
    class Base 
      
      ##
      # Access the current command runner via +@runner+.

      def initialize runner
        @runner = runner
      end
      
      ##
      # Renders global help.
      
      def render
        "Implement global help here"
      end
      
      ##
      # Renders +command+ specific help.
      
      def render_command command
        "Implement help for #{command.name} here"
      end
      
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
visionmedia-commander-2.4.2 lib/commander/help_formatters/base.rb
visionmedia-commander-2.4.3 lib/commander/help_formatters/base.rb
visionmedia-commander-2.4.4 lib/commander/help_formatters/base.rb
visionmedia-commander-2.4.6 lib/commander/help_formatters/base.rb
visionmedia-commander-2.5.6 lib/commander/help_formatters/base.rb
visionmedia-commander-2.5.7 lib/commander/help_formatters/base.rb