Adds YARD documentation listing valid color symbols for color config

charliemaffitt · Dec 20, 2012 · e579968 · e579968
1 parent 7c0e3a4
commit e579968
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/rspec/core/configuration.rb b/lib/rspec/core/configuration.rb
@@ -127,8 +127,9 @@ def self.add_setting(name, opts={})
 
       # Run all examples if none match the configured filters (default: `false`).
       add_setting :run_all_when_everything_filtered
-      
+
       # Allow user to configure their own success/pending/failure colors
+      # @param [Symbol] should be one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]
       add_setting :success_color
       add_setting :pending_color
       add_setting :failure_color