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

;doc: clarify that --forecast ignores a report interval (#1632)

Browse Source
This commit is contained in:
Simon Michael 2021-08-20 17:34:23 -10:00
parent 780c50672c
commit d3d1b2cfc7
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
hledger/hledger.m4.md
View File

@ -3182,13 +3182,15 @@ prevent generation of periodic transactions.
periodic rule instead - put tilde before the date, eg `~ YYYY-MM-DD ...`). periodic rule instead - put tilde before the date, eg `~ YYYY-MM-DD ...`).
Or, you can set your own arbitrary "forecast period", which can Or, you can set your own arbitrary "forecast period", which can
overlap recorded transactions, and need not be in the future, by overlap recorded transactions, and need not be in the future.
providing an option argument, like `--forecast=PERIODEXPR`. To do this, provide a [period expression](#period-expressions) argument, like `--forecast=PERIODEXPR`.
Note the equals sign is required, a space won't work. Note:
PERIODEXPR is a [period expression](#period-expressions),
which can specify the start date, end date, or both, - the equals sign is required (a space won't work)
like in a [`date:` query](#queries). - PERIODEXPR can specify the forecast period's start and/or end dates
(See also hledger.1 -> [Report start & end date](#report-start-end-date)). (similar to [Report start & end date](#report-start--end-date))
- PERIODEXPR shouldn't specify a report interval; that would be ignored, as it is specified by the periodic rules in the journal.
Some examples: `--forecast=202001-202004`, `--forecast=jan-`, `--forecast=2020`. Some examples: `--forecast=202001-202004`, `--forecast=jan-`, `--forecast=2020`.
### Budgeting with periodic transactions ### Budgeting with periodic transactions