slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;lib: clarify journalAddForecast doc (#835)

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-09-09 13:26:43 -07:00
parent 85d48a6b0e
commit 538e97f3ac
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hledger/Hledger/Cli/Utils.hs
View File

@ -123,15 +123,16 @@ anonymise j
-- | Generate periodic transactions from all periodic transaction rules in the journal. -- | Generate periodic transactions from all periodic transaction rules in the journal.
-- These transactions are added to the in-memory Journal (but not the on-disk file). -- These transactions are added to the in-memory Journal (but not the on-disk file).
-- --
-- They start on or after the day following the latest normal transaction in the journal, -- They can start no earlier than: the day following the latest normal
-- or today if there are none. -- transaction in the journal (or today if there are none).
-- They end on or before the specified report end date, or 180 days from today if unspecified. -- They end on or before the specified report end date, or 180 days
-- from today if unspecified.
-- --
journalAddForecast :: CliOpts -> Journal -> IO Journal journalAddForecast :: CliOpts -> Journal -> IO Journal
journalAddForecast opts@CliOpts{inputopts_=iopts, reportopts_=ropts} j = do journalAddForecast opts@CliOpts{inputopts_=iopts, reportopts_=ropts} j = do
today <- getCurrentDay today <- getCurrentDay
-- "They start on or after the day following the latest normal transaction in the journal, or today if there are none." -- "They can start no earlier than: the day following the latest normal transaction in the journal (or today if there are none)."
let mjournalend = dbg2 "journalEndDate" $ journalEndDate False j -- ignore secondary dates let mjournalend = dbg2 "journalEndDate" $ journalEndDate False j -- ignore secondary dates
forecaststart = dbg2 "forecaststart" $ fromMaybe today mjournalend forecaststart = dbg2 "forecaststart" $ fromMaybe today mjournalend