From 5c0105b2c1811db639f94ad64c7e4b2277307060 Mon Sep 17 00:00:00 2001 From: Michael Kessler Date: Mon, 10 Oct 2011 08:29:43 +0200 Subject: [PATCH] Describe why UI class uses STDERR. --- lib/guard/ui.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/guard/ui.rb b/lib/guard/ui.rb index 47fd0a4..77ed825 100644 --- 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