module PuppetStrings::Yard::Handlers::Helpers

Implements a helper that logs a warning if a summary tag has more than 140 characters

Public Class Methods

validate_summary_tag(object) click to toggle source
# File lib/puppet-strings/yard/handlers/helpers.rb, line 5
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