From ade9afbcb36cd5e635dbae876801f048b0dc2313 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 21 Apr 2023 11:33:22 -1000 Subject: [PATCH] ;doc: forecasting: edits --- hledger/hledger.m4.md | 40 ++++++++++++---------------------------- 1 file changed, 12 insertions(+), 28 deletions(-) diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index 7c3807b34..795a92909 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -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` - - +- 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