Document report options (inputs for chargeback)

After spending 15 minutes of head scratching.
isimluk · Jan 5, 2017 · 2270d42 · 2270d42
1 parent d379d4c
commit 2270d42
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/app/models/chargeback/report_options.rb b/app/models/chargeback/report_options.rb
@@ -2,8 +2,8 @@ class Chargeback
   # ReportOptions are usualy stored in MiqReport.db_options[:options]
   ReportOptions = Struct.new(
     :interval,             # daily | weekly | monthly
-    :interval_size,
-    :end_interval_offset,
+    :interval_size,        # number of :intervals in the report (i.e. `12` months, `4` weeks)
+    :end_interval_offset,  # report ends :intervals ago (i.e. `3` months ago, or `2` weeks ago)
     :owner,                # userid
     :tenant_id,
     :tag,                  # like /managed/environment/prod (Mutually exclusive with :user)