From 83f633051eb24440424fe8700bbc49caa74c0589 Mon Sep 17 00:00:00 2001 From: Stephen Pike Date: Fri, 20 Apr 2012 15:15:11 -0400 Subject: Add some more documentation for example of conditional formatting --- lib/axlsx/workbook/worksheet/worksheet.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb index 59e57ac2..407a25e5 100644 --- a/lib/axlsx/workbook/worksheet/worksheet.rb +++ b/lib/axlsx/workbook/worksheet/worksheet.rb @@ -128,10 +128,12 @@ module Axlsx # # @param [String] cells The range to apply the formatting to # @param [Array|Hash] rules An array of hashes (or just one) to create Conditional formatting rules from. - # @example This would format column A whenever it is FALSE + # @example This would format column A whenever it is FALSE. + # # for a longer example, see examples/example_conditional_formatting.rb (link below) # worksheet.add_conditional_formatting( "A1:A1048576", { :type => :cellIs, :operator => :equal, :formula => "FALSE", :dxfId => 1, :priority => 1 } # # @see ConditionalFormattingRule#initialize + # @see file:examples/example_conditional_formatting.rb def add_conditional_formatting(cells, rules) cf = ConditionalFormatting.new( :sqref => cells ) cf.add_rules rules -- cgit v1.2.3