class YARD::Logger

Public Instance Methods

show_progress() click to toggle source
# File lib/puppet_x/puppetlabs/strings/yard/monkey_patches.rb, line 33
def show_progress
  return false if YARD.ruby18? # threading is too ineffective for progress support
  return false if YARD.windows? # windows has poor ANSI support
  return false unless io.tty? # no TTY support on IO
  # Here is the actual monkey patch. A simple fix to an inverted conditional.
  # Without this Pry is unusable for debugging as the progress bar goes
  # craaaaaaaazy.
  return false unless level > INFO # no progress in verbose/debug modes
  @show_progress
end
warn(warning) click to toggle source

Redirect Yard command line warnings to a log file called .yardwarns Yard warnings may be irrelevant, spurious, or may not conform with our styling and UX design. They are also printed on stdout by default.

# File lib/puppet_x/puppetlabs/strings/yard/monkey_patches.rb, line 47
def warn warning
  f = File.new '.yardwarns', 'a'
  f.write warning
  f.close()
end