From 5a13bc632d7dc2bae2d0b26692b7f8497dc903d8 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 5 May 2019 10:09:40 -0700 Subject: [PATCH] ;clarify ledgerFromJournal doc --- hledger-lib/Hledger/Data/Ledger.hs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/hledger-lib/Hledger/Data/Ledger.hs b/hledger-lib/Hledger/Data/Ledger.hs index 083455459..d29fe9b3a 100644 --- a/hledger-lib/Hledger/Data/Ledger.hs +++ b/hledger-lib/Hledger/Data/Ledger.hs @@ -53,10 +53,11 @@ nullledger = Ledger { laccounts = [] } --- | Filter a journal's transactions with the given query, then derive --- a ledger containing the chart of accounts and balances. If the --- query includes a depth limit, that will affect the ledger's --- journal but not the ledger's account tree. +-- | Filter a journal's transactions with the given query, then build +-- a "Ledger", containing the journal plus the tree of all its +-- accounts with their subaccount-inclusive and subaccount-exclusive +-- balances. If the query includes a depth limit, the ledger's journal +-- will be depth limited, but the ledger's account tree will not. ledgerFromJournal :: Query -> Journal -> Ledger ledgerFromJournal q j = nullledger{ljournal=j'', laccounts=as} where