;lib: periodFromRawOpts: clarify doc (#1011)

[ci skip]
2019-07-01 18:33:06 +01:00 · 2019-07-01 18:33:06 +01:00 · 5c3e4de647
commit 5c3e4de647
parent 1bc246681f
1 changed files with 5 additions and 2 deletions
--- a/hledger-lib/Hledger/Reports/ReportOptions.hs
+++ b/hledger-lib/Hledger/Reports/ReportOptions.hs
@ -228,8 +228,11 @@ balancetypeopt rawopts =
    ("cumulative":_) -> CumulativeChange
    _                -> PeriodChange

-- Get the period specified by the intersection of -b/--begin, -e/--end and/or
-- -p/--period options, using the given date to interpret relative date expressions.
+-- Get the period specified by any -b/--begin, -e/--end and/or -p/--period
+-- options appearing in the command line.
+-- Its bounds are the rightmost begin date specified by a -b or -p, and
+-- the rightmost end date specified by a -e or -p. Cf #1011.
+-- Today's date is provided to help interpret any relative dates.
 periodFromRawOpts :: Day -> RawOpts -> Period
 periodFromRawOpts d rawopts =
  case (mlastb, mlaste) of