From ae73eea7cbac0b425a7572dd674a304a5be21b86 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 3 Mar 2021 11:53:40 -0800 Subject: [PATCH] ;bs,bse,cf,is: update docs --- hledger/Hledger/Cli/Commands/Balancesheet.md | 18 +++++------------- .../Hledger/Cli/Commands/Balancesheetequity.md | 9 +++++---- hledger/Hledger/Cli/Commands/Cashflow.md | 14 ++++---------- .../Hledger/Cli/Commands/Incomestatement.md | 16 +++++----------- 4 files changed, 19 insertions(+), 38 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.md b/hledger/Hledger/Cli/Commands/Balancesheet.md index 6289da334..04fef9b36 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.md +++ b/hledger/Hledger/Cli/Commands/Balancesheet.md @@ -12,10 +12,6 @@ with the `Asset` or `Cash` or `Liability` type, or otherwise all accounts under a top-level `asset` or `liability` account (case insensitive, plurals allowed). -(This report is essentially similar to -"hledger balance --historical assets liabilities", -with liabilities sign-flipped.) - Example: ```shell @@ -39,15 +35,11 @@ Total: 0 ``` -With a [reporting interval](#reporting-interval), multiple columns -will be shown, one for each report period. -As with [multicolumn balance reports](#multicolumn-balance-reports), -you can alter the report mode with `--change`/`--cumulative`/`--historical`. -Normally balancesheet shows historical ending balances, which is what -you need for a balance sheet; note this means it ignores report begin -dates (and `-T/--row-total`, since summing end balances generally does not make sense). -Instead of absolute values [percentages](#percentages) can be displayed -with `-%`. +This command is a higher-level variant of the [`balance`](#balance) command, +and supports many of that command's features, such as multi-period reports. +It is similar to `hledger balance -H assets liabilities`, +but with smarter account detection, and liabilities displayed with +their sign flipped. This command also supports the [output destination](hledger.html#output-destination) and diff --git a/hledger/Hledger/Cli/Commands/Balancesheetequity.md b/hledger/Hledger/Cli/Commands/Balancesheetequity.md index 14f3605d6..71c267cdf 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheetequity.md +++ b/hledger/Hledger/Cli/Commands/Balancesheetequity.md @@ -11,10 +11,6 @@ declared with the `Asset`, `Cash`, `Liability` or `Equity` type, or otherwise all accounts under a top-level `asset`, `liability` or `equity` account (case insensitive, plurals allowed). -(This report is essentially similar to -"hledger balance --historical assets liabilities equity", -with liabilities and equity sign-flipped.) - Example: ```shell $ hledger balancesheetequity @@ -42,6 +38,11 @@ Total: 0 ``` +This command is a higher-level variant of the [`balance`](#balance) command, +and supports many of that command's features, such as multi-period reports. +It is similar to `hledger balance -H assets liabilities equity`, +but with smarter account detection, and liabilities/equity displayed with +their sign flipped. This command also supports the [output destination](hledger.html#output-destination) and diff --git a/hledger/Hledger/Cli/Commands/Cashflow.md b/hledger/Hledger/Cli/Commands/Cashflow.md index 4f1cb13c5..ae1a63d2f 100644 --- a/hledger/Hledger/Cli/Commands/Cashflow.md +++ b/hledger/Hledger/Cli/Commands/Cashflow.md @@ -11,9 +11,6 @@ type, or otherwise all accounts under a top-level `asset` account (case insensitive, plural allowed) which do not have `fixed`, `investment`, `receivable` or `A/R` in their name. -(This report is essentially similar to -"hledger balance --change assets not:fixed not:investment not:receivable".) - Example: ```shell $ hledger cashflow @@ -31,13 +28,10 @@ Total: $-1 ``` -With a [reporting interval](#reporting-interval), multiple columns -will be shown, one for each report period. -Normally cashflow shows changes in assets per period, though -as with [multicolumn balance reports](#multicolumn-balance-reports) -you can alter the report mode with `--change`/`--cumulative`/`--historical`. -Instead of absolute values [percentages](#percentages) can be displayed -with `-%`. +This command is a higher-level variant of the [`balance`](#balance) command, +and supports many of that command's features, such as multi-period reports. +It is similar to `hledger balance assets not:fixed not:investment not:receivable`, +but with smarter account detection. This command also supports the [output destination](hledger.html#output-destination) and diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.md b/hledger/Hledger/Cli/Commands/Incomestatement.md index a668d5aee..8b02512fe 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.md +++ b/hledger/Hledger/Cli/Commands/Incomestatement.md @@ -13,10 +13,6 @@ with the `Revenue` or `Expense` type, or otherwise all accounts under a top-level `revenue` or `income` or `expense` account (case insensitive, plurals allowed). -(This report is essentially similar to -"hledger balance --change revenues expenses", -with revenues sign-flipped.) - Example: ```shell $ hledger incomestatement @@ -41,13 +37,11 @@ Total: 0 ``` -With a [reporting interval](#reporting-interval), multiple columns -will be shown, one for each report period. -Normally incomestatement shows revenues/expenses per period, though -as with [multicolumn balance reports](#multicolumn-balance-reports) -you can alter the report mode with `--change`/`--cumulative`/`--historical`. -Instead of absolute values [percentages](#percentages) can be displayed -with `-%`. +This command is a higher-level variant of the [`balance`](#balance) command, +and supports many of that command's features, such as multi-period reports. +It is similar to `hledger balance '(revenues|income)' expenses`, +but with smarter account detection, and revenues/income displayed with +their sign flipped. This command also supports the [output destination](hledger.html#output-destination) and