From fe6df964b432a16a3794cd8ec3cd724b83478912 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 25 Apr 2023 12:39:28 -1000 Subject: [PATCH] ;doc: bal: try to improve description of budget report differences --- hledger/Hledger/Cli/Commands/Balance.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Balance.md b/hledger/Hledger/Cli/Commands/Balance.md index a8e57acf3..04df62a47 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -548,18 +548,14 @@ Budget performance in 2017/11/01-2017/12/31: || 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. - -- In each column, in square brackets after the actual amount, - budget goal amounts are shown, and the actual/goal percentage. - (Note: budget goals should be in the same commodity as the actual amount.) - -- 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. +- Accounts with budget goals during the report period, and their parents, are shown. +- Their subaccounts are not shown (regardless of the depth setting). +- Accounts without budget goals, if any, are aggregated and shown as "\". +- Amounts are always inclusive (subaccount-including), even in list mode. +- After each actual amount, the corresponding goal amount and percentage + of goal reached are also shown, in square brackets. This means that the numbers displayed will not always add up! Eg above, the `expenses` actual amount includes the gifts and supplies transactions,