Documentation comments - reportable - Fork of reportable required by WarVox, from hdm/reportable.
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
       ---
 (DIR) commit 0fee5f1a9dde0d9ce504a34db9553e41c2df52de
 (DIR) parent 498c6adcdb7b2261580d7d32d6b991702fe09804
 (HTM) Author: Pedro Freitas <pelf@webreakstuff.com>
       Date:   Wed, 27 Mar 2013 17:59:16 +0000
       
       Documentation comments
       
       Diffstat:
         M lib/saulabs/reportable.rb           |       3 ++-
         M lib/saulabs/reportable/report.rb    |       2 ++
       
       2 files changed, 4 insertions(+), 1 deletion(-)
       ---
 (DIR) diff --git a/lib/saulabs/reportable.rb b/lib/saulabs/reportable.rb
       @@ -38,7 +38,8 @@ module Saulabs
                #   the number of reporting periods to get (see +:grouping+)
                # @option options [Hash] :conditions ({})
                #   conditions like in +ActiveRecord::Base#find+; only records that match these conditions are reported;
       -        
       +        # @option options [Hash] :include ({})
       +        #   include like in +ActiveRecord::Base#find+; names associations that should be loaded alongside; the symbols named refer to already defined associations
                # @option options [Boolean] :live_data (false)
                #   specifies whether data for the current reporting period is to be read; <b>if +:live_data+ is +true+, you will experience a performance hit since the request cannot be satisfied from the cache alone</b>
                # @option options [DateTime, Boolean] :end_date (false)
 (DIR) diff --git a/lib/saulabs/reportable/report.rb b/lib/saulabs/reportable/report.rb
       @@ -54,6 +54,8 @@ module Saulabs
              #   the number of reporting periods to get (see +:grouping+)
              # @option options [Hash] :conditions ({})
              #   conditions like in +ActiveRecord::Base#find+; only records that match these conditions are reported;
       +      # @option options [Hash] :include ({})
       +      #   include like in +ActiveRecord::Base#find+; names associations that should be loaded alongside; the symbols named refer to already defined associations
              # @option options [Boolean] :live_data (false)
              #   specifies whether data for the current reporting period is to be read; <b>if +:live_data+ is +true+, you will experience a performance hit since the request cannot be satisfied from the cache alone</b>
              # @option options [DateTime, Boolean] :end_date (false)