Method: YARD::Logger#show_progress

Defined in:
lib/yard/logging.rb

#show_progress ⇒ Boolean

Returns whether progress indicators should be shown when logging CLIs (by default this is off).

Returns:

  • (Boolean) —

    whether progress indicators should be shown when logging CLIs (by default this is off).



27
28
29
30
31
32
33
 
# File 'lib/yard/logging.rb', line 27

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
  return false unless level > INFO # no progress in verbose/debug modes
  @show_progress
end