puppetlabs/puppet · error · ArgumentError

Face summary should be a single line; put the long text in '

Error message

Face summary should be a single line; put the long text in 'description' instead.

What it means

Error "Face summary should be a single line; put the long text in 'description' instead." thrown in puppetlabs/puppet.

Source

Thrown at lib/puppet/interface/documentation.rb:62

        end                                                                 # end
      EOT
    end
  end

  # This module can be mixed in to provide a minimal set of
  # documentation attributes.
  # @api public
  module TinyDocs
    extend Puppet::Interface::DocGen

    # @!method summary(summary)
    # Sets a summary of this object.
    # @api public
    # @dsl Faces
    attr_doc :summary do |value|
      value =~ /\n/ and
        # TRANSLATORS 'Face' refers to a programming API in Puppet, 'summary' and 'description' are specifc attribute names and should not be translated
        raise ArgumentError, _("Face summary should be a single line; put the long text in 'description' instead.")
      value
    end

    # @!method description(description)
    # Sets the long description of this object.
    # @param description [String] The description of this object.
    # @api public
    # @dsl Faces
    attr_doc :description

    # @api private
    def build_synopsis(face, action = nil, arguments = nil)
      PrettyPrint.format do |s|
        s.text("puppet #{face}")
        s.text(" #{action}") unless action.nil?
        s.text(" ")

        options.each do |option|

View on GitHub (pinned to e227c27540)

When it happens

Trigger: Thrown at lib/puppet/interface/documentation.rb:62 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of puppetlabs/puppet@e227c27540 (2026-08-21). Data as JSON: /api/errors/d5422f7f79f35bb1. Report an issue: GitHub.