Sha256: b9973179784a3f2c5d62d781b9aae641da2d913a402eb4eb0189118f43db4b22

Contents?: true

Size: 372 Bytes

Versions: 11

Compression:

Stored size: 372 Bytes

Contents

module PuppetStrings::Yard::Handlers::Helpers
  # Logs a warning if a summary tag has more than 140 characters
  def self.validate_summary_tag(object)
    if object.has_tag?(:summary) && object.tag(:summary).text.length > 140
      log.warn "The length of the summary for #{object.type} '#{object.name}' exceeds the recommended limit of 140 characters."
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
puppet-strings-2.5.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.4.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.3.1 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.3.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.2.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.1.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-2.0.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-1.2.1 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-1.2.0 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-1.1.1 lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-1.1.0 lib/puppet-strings/yard/handlers/helpers.rb