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

lib: doc: clarify how forecast transaction dates work (#835)

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2018-07-04 09:35:47 +01:00
parent b57bb01180
commit 0322638cf5
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
hledger-lib/hledger_journal.m4.md
View File

@ -1016,11 +1016,18 @@ These are not saved in the journal, but appear in all reports.
They will look like normal transactions, but with an extra
[tag](manual.html#tags-1) named `recur`, whose value is the generating period expression.
Forecast transactions begin
on or after the day after the latest normal (non-periodic) transaction in the journal,
or today if there are none.
Forecast transactions start on the first occurrence, and end on the last occurrence,
of their interval within the forecast period. The forecast period:
They end on or before the report end date if specified, or 180 days from today if unspecified.
- begins on the later of
- the report start date if specified with -b/-p/date:
- the day after the latest normal (non-periodic) transaction in the journal,
(or today if there are no normal transactions).
- ends on the report end date if specified with -e/-p/date:,
or 180 days from today.
where "today" means the current date at report time.
Forecasting can be useful for estimating balances into the future,
and experimenting with different scenarios.