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

;doc: forecasting: edits

Browse Source
This commit is contained in:
Simon Michael 2023-04-21 11:33:22 -10:00
parent bb64bb1961
commit ade9afbcb3
1 changed files with 12 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
hledger/hledger.m4.md
View File

@ -4943,7 +4943,7 @@ Balance changes in 2023-05-01..2023-09-30:
|| $1000 $1000 $1000 $1000 $1000
```
## Forecast transaction tags
## Forecast tags
The `generated-transaction` tags are added by hledger; they indicate transactions generated by --forecast, and show which rule was responsible. If you ever need to match forecast transactions, you could use `tag:generated-transaction` in a query.
@ -4972,35 +4972,19 @@ The forecast period ends on:
- otherwise: 180 days (~6 months) from today.
## Forecast troubleshooting
When --forecast is not doing what you expect, here are some tips.
Can't see what it's doing ?
- Test with `print --forecast`.
No forecast transactions are visible ?
When --forecast is not doing what you expect, one of these tips should help:
- Remember to use the `--forecast` option.
- Remember to create at least one periodic transaction rule in your journal.
- Check for typos or restrictive start/end dates in your periodic transaction rule.
- If your rule contains a transaction description, be sure to separate it from the period expression by at least 2 spaces.
- Check for a future dated ordinary transaction suppressing forecasted transactions.
- Set an explicit report end date with `-e`, `-p` or `date:`.
- Add the `-E` flag to encourage display of empty periods/zero transactions.
- Consult [Forecast period, in detail](#forecast-period-in-detail) above.
- Check inside the engine: add the --debug option, eg `--debug=2`.
Forecast transactions are visible, but starting or ending too soon/too late ?
- First, adjust (or remove) any start/end dates within your periodic transaction rule.
- Next try setting explicit report start and/or end dates with `-b`, `-e`, `-p` or `date:`.
- And/or override the forecast start and/or end date with `--forecast=STARTDATE..ENDDATE`
<!--
A future-dated transaction is making it harder to generate forecast transactions ?
- If you have recorded some important future event as an ordinary transaction, and it is interfering with easy --forecast-ing, you could consider making it a (non-recurring) forecast transaction instead. Just insert a `~` before the date and make sure there 2+ spaces after the date. Then it won't suppress other forecast transactions (and you'll have to use `--forecast` to see it).
-->
- Remember to have at least one periodic transaction rule in your journal.
- Test with `print --forecast`.
- Check for typos or too-restrictive start/end dates in your periodic transaction rule.
- Leave at least 2 spaces between the rule's period expression and description fields.
- Check for future-dated ordinary transactions suppressing forecasted transactions.
- Try setting explicit report start and/or end dates with `-b`, `-e`, `-p` or `date:`
- Try adding the `-E` flag to encourage display of empty periods/zero transactions.
- Try setting explicit forecast start and/or end dates with `--forecast=START..END`
- Consult [Forecast period, in detail](#forecast-period-in-detail), above.
- Check inside the engine: add `--debug=2` (eg).
# Budgeting