{"record":{"id":"d5422f7f79f35bb1","repo":"puppetlabs/puppet","slug":"face-summary-should-be-a-single-line-put-the-long","errorCode":null,"errorMessage":"Face summary should be a single line; put the long text in 'description' instead.","messagePattern":"Face summary should be a single line; put the long text in 'description' instead\\.","errorType":"validation","errorClass":"ArgumentError","httpStatus":null,"severity":"error","filePath":"lib/puppet/interface/documentation.rb","lineNumber":62,"sourceCode":"        end                                                                 # end\n      EOT\n    end\n  end\n\n  # This module can be mixed in to provide a minimal set of\n  # documentation attributes.\n  # @api public\n  module TinyDocs\n    extend Puppet::Interface::DocGen\n\n    # @!method summary(summary)\n    # Sets a summary of this object.\n    # @api public\n    # @dsl Faces\n    attr_doc :summary do |value|\n      value =~ /\\n/ and\n        # TRANSLATORS 'Face' refers to a programming API in Puppet, 'summary' and 'description' are specifc attribute names and should not be translated\n        raise ArgumentError, _(\"Face summary should be a single line; put the long text in 'description' instead.\")\n      value\n    end\n\n    # @!method description(description)\n    # Sets the long description of this object.\n    # @param description [String] The description of this object.\n    # @api public\n    # @dsl Faces\n    attr_doc :description\n\n    # @api private\n    def build_synopsis(face, action = nil, arguments = nil)\n      PrettyPrint.format do |s|\n        s.text(\"puppet #{face}\")\n        s.text(\" #{action}\") unless action.nil?\n        s.text(\" \")\n\n        options.each do |option|","sourceCodeStart":44,"sourceCodeEnd":80,"githubUrl":"https://github.com/puppetlabs/puppet/blob/e227c27540975c25aa22d533a52424a9d2fc886a/lib/puppet/interface/documentation.rb#L44-L80","documentation":"Error \"Face summary should be a single line; put the long text in 'description' instead.\" thrown in puppetlabs/puppet.","triggerScenarios":"Thrown at lib/puppet/interface/documentation.rb:62 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":[],"exampleFix":null,"handlingStrategy":null,"validationCode":null,"typeGuard":null,"tryCatchPattern":null,"preventionTips":[],"tags":[],"backgroundTag":null,"analyzedSha":"e227c27540975c25aa22d533a52424a9d2fc886a","analyzedAt":"2026-08-21T20:49:46.650Z","schemaVersion":2},"datasetVersion":"2026-08-21T23:17:16.201Z"}