summaryrefslogtreecommitdiff
path: root/lib/chef/formatters/doc.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/formatters/doc.rb')
-rw-r--r--lib/chef/formatters/doc.rb6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/chef/formatters/doc.rb b/lib/chef/formatters/doc.rb
index 7144d00b5d..860cd8b2b3 100644
--- a/lib/chef/formatters/doc.rb
+++ b/lib/chef/formatters/doc.rb
@@ -3,9 +3,9 @@ require 'chef/config'
class Chef
module Formatters
- #--
- # TODO: not sold on the name, but the output is similar to what rspec calls
- # "specdoc"
+
+ # Formatter similar to RSpec's documentation formatter. Uses indentation to
+ # show context.
class Doc < Formatters::Base
attr_reader :start_time, :end_time, :successful_audits, :failed_audits