From e105cdee98afd82bf1c66565b78f8da3e30b8c07 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 31 Mar 2017 17:40:20 -0700 Subject: [PATCH] bs/cf/is: more informative usage, mention begin date (#518) --- hledger/Hledger/Cli/Balancesheet.hs | 7 ++++++- hledger/Hledger/Cli/Cashflow.hs | 7 ++++++- hledger/Hledger/Cli/Incomestatement.hs | 8 +++++++- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/hledger/Hledger/Cli/Balancesheet.hs b/hledger/Hledger/Cli/Balancesheet.hs index 4b0557664..9149a96eb 100644 --- a/hledger/Hledger/Cli/Balancesheet.hs +++ b/hledger/Hledger/Cli/Balancesheet.hs @@ -11,6 +11,7 @@ module Hledger.Cli.Balancesheet ( ,tests_Hledger_Cli_Balancesheet ) where +import Data.String.Here import System.Console.CmdArgs.Explicit import Test.HUnit @@ -21,7 +22,11 @@ import Hledger.Cli.BalanceView bsBV = BalanceView { bvmode = "balancesheet", bvaliases = ["bs"], - bvhelp = "show a balance sheet", + bvhelp = [here|This command displays a simple balance sheet, showing historical ending +balances of asset and liability accounts (ignoring any report begin date). +It assumes that these accounts are under a top-level `asset` or `liability` +account (plural forms also allowed). + |], bvtitle = "Balance Sheet", bvqueries = [ ("Assets" , journalAssetAccountQuery), ("Liabilities", journalLiabilityAccountQuery) diff --git a/hledger/Hledger/Cli/Cashflow.hs b/hledger/Hledger/Cli/Cashflow.hs index 7fd8fcdbb..4abb6f2f4 100644 --- a/hledger/Hledger/Cli/Cashflow.hs +++ b/hledger/Hledger/Cli/Cashflow.hs @@ -14,6 +14,7 @@ module Hledger.Cli.Cashflow ( ,tests_Hledger_Cli_Cashflow ) where +import Data.String.Here import System.Console.CmdArgs.Explicit import Test.HUnit @@ -24,7 +25,11 @@ import Hledger.Cli.BalanceView cfBV = BalanceView { bvmode = "cashflow", bvaliases = ["cf"], - bvhelp = "show a cashflow statement", + bvhelp = [here|This command displays a simple cashflow statement, showing changes +in "cash" accounts. It assumes that these accounts are under a top-level +`asset` account and do not contain `receivable` or `A/R` in their name +(plural forms also allowed). + |], bvtitle = "Cashflow Statement", bvqueries = [("Cash flows", journalCashAccountQuery)], bvtype = PeriodChange diff --git a/hledger/Hledger/Cli/Incomestatement.hs b/hledger/Hledger/Cli/Incomestatement.hs index 5eacfc7e9..09fe470b8 100644 --- a/hledger/Hledger/Cli/Incomestatement.hs +++ b/hledger/Hledger/Cli/Incomestatement.hs @@ -11,6 +11,7 @@ module Hledger.Cli.Incomestatement ( ,tests_Hledger_Cli_Incomestatement ) where +import Data.String.Here import System.Console.CmdArgs.Explicit import Test.HUnit @@ -21,7 +22,12 @@ import Hledger.Cli.BalanceView isBV = BalanceView { bvmode = "incomestatement", bvaliases = ["is"], - bvhelp = "show an income statement", + bvhelp = [here|This command displays a simple income statement, showing revenues +and expenses during a period. It assumes that these accounts are under a +top-level `revenue` or `income` or `expense` account (plural forms +also allowed). + + |], bvtitle = "Income Statement", bvqueries = [ ("Revenues", journalIncomeAccountQuery), ("Expenses", journalExpenseAccountQuery)