Describe why UI class uses STDERR.

2011-10-10 08:29:43 +02:00 · 2011-10-10 08:29:43 +02:00 · 5c0105b2c1
commit 5c0105b2c1
parent 6f1a0acb2e
1 changed files with 6 additions and 1 deletions
--- a/lib/guard/ui.rb
+++ b/lib/guard/ui.rb
@ -1,6 +1,11 @@
 module Guard

-  # The UI class helps to format messages for the user.
+  # The UI class helps to format messages for the user. Everything that is logged
+  # through this class is considered either as an error message or a diagnostic
+  # message and is written to standard error (STDERR).
+  #
+  # If your Guard does some output that is piped into another process for further
+  # processing, please just write it to STDOUT with `puts`.
  #
  module UI
    class << self