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

;doc: bal: try to improve description of budget report differences

Browse Source
This commit is contained in:
Simon Michael 2023-04-25 12:39:28 -10:00
parent f3be461045
commit fe6df964b4
1 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -548,18 +548,14 @@ Budget performance in 2017/11/01-2017/12/31:
|| 0 [ 0] 0 [ 0] || 0 [ 0] 0 [ 0]
``` ```
This is different from a normal balance report in several ways: This is different from a normal balance report in several ways. Currently:
- Only accounts with budget goals during the report period are shown, by default. - Accounts with budget goals during the report period, and their parents, are shown.
- Their subaccounts are not shown (regardless of the depth setting).
- In each column, in square brackets after the actual amount, - Accounts without budget goals, if any, are aggregated and shown as "\<unbudgeted>".
budget goal amounts are shown, and the actual/goal percentage. - Amounts are always inclusive (subaccount-including), even in list mode.
(Note: budget goals should be in the same commodity as the actual amount.) - After each actual amount, the corresponding goal amount and percentage
of goal reached are also shown, in square brackets.
- All parent accounts are always shown, even in list mode.
Eg assets, assets:bank, and expenses above.
- Amounts always include all subaccounts, budgeted or unbudgeted, even in list mode.
This means that the numbers displayed will not always add up! This means that the numbers displayed will not always add up!
Eg above, the `expenses` actual amount includes the gifts and supplies transactions, Eg above, the `expenses` actual amount includes the gifts and supplies transactions,