add note on why commented line is commented

1 files changed, 2 insertions, 0 deletions

diff --git a/lib/chef/formatters/base.rb b/lib/chef/formatters/base.rb
index af041a5081..c901068aa0 100644
--- a/lib/chef/formatters/base.rb
+++ b/lib/chef/formatters/base.rb
@@ -94,6 +94,8 @@ class Chef
       def indent_by(amount)
         @output.indent += amount
         if @output.indent < 0
+          # This is left commented out for now.  We need to uncomment it and fix at least one bug in
+          # the formatter, and then leave this line uncommented in the future.
           #Chef::Log.warn "Internal Formatter Error -- Attempt to indent by negative number of spaces"
           @output.indent = 0
         end