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

;bal: budget: improve doc

Browse Source
This commit is contained in:
Simon Michael 2020-11-20 17:20:50 -08:00
parent 322d62483e
commit 16f12d8263
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
hledger/Hledger/Cli/Commands/Balance.md
View File

@ -448,12 +448,14 @@ For more examples and notes, see [Budgeting](budgeting.html).
#### Budget report start date #### Budget report start date
When making budget reports, it's a good idea to explicitly set the This might be a bug, but for now:
when making budget reports, it's a good idea to explicitly set the
report's start date to the first day of a reporting period, because report's start date to the first day of a reporting period, because
a periodic rule like `~ monthly` generates its transactions on the 1st a periodic rule like `~ monthly` generates its transactions on the 1st
of each month, and if your journal has no regular transactions on the 1st, of each month, and if your journal has no regular transactions on the 1st,
the default report start date could exclude that budget goal, which can the default report start date could exclude that budget goal, which can
be a little surprising: be a little surprising. Eg here the default report period is just the
day of 2020-01-15:
```journal ```journal
~ monthly in 2020 ~ monthly in 2020
@ -464,29 +466,29 @@ be a little surprising:
assets:checking assets:checking
``` ```
```shell ```shell
$ hledger -f- bal --budget -M $ hledger bal expenses --budget
Budget performance in 2020-01: Budget performance in 2020-01-15:
|| Jan || 2020-01-15
==============++===== ==============++============
<unbudgeted> || 0 <unbudgeted> || $400
--------------++----- --------------++------------
|| 0 || $400
``` ```
To avoid this, specify the report period, or at least the start date, To avoid this, specify the budget report's period, or at least the start date,
with `-b`/`-p`/`date:`. Eg: with `-b`/`-e`/`-p`/`date:`, to ensure it includes the budget goal transactions
(periodic transactions) that you want. Eg, adding `-b 2020/1/1` to the above:
```shell ```shell
$ hledger -f a.j bal --budget -M -b 2020/1/1 $ hledger bal expenses --budget -b 2020/1/1
Budget performance in 2020-01: Budget performance in 2020-01-01..2020-01-15:
|| Jan || 2020-01-01..2020-01-15
===============++===================== ===============++========================
<unbudgeted> || $-400 expenses:food || $400 [80% of $500]
expenses:food || $400 [80% of $500] ---------------++------------------------
---------------++--------------------- || $400 [80% of $500]
|| 0 [ 0% of $500]
``` ```
#### Nested budgets #### Nested budgets