Contents

# frozen_string_literal: true

# Implements a helper that logs a warning if a summary tag has more than 140 characters
module PuppetStrings::Yard::Handlers::Helpers
  def self.validate_summary_tag(object)
    return unless 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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
puppet-strings-3.0.1	lib/puppet-strings/yard/handlers/helpers.rb
puppet-strings-3.0.0	lib/puppet-strings/yard/handlers/helpers.rb