;clarify ledgerFromJournal doc

This commit is contained in:
Simon Michael 2019-05-05 10:09:40 -07:00
parent 1ad82d5b77
commit 5a13bc632d

View File

@ -53,10 +53,11 @@ nullledger = Ledger {
laccounts = [] laccounts = []
} }
-- | Filter a journal's transactions with the given query, then derive -- | Filter a journal's transactions with the given query, then build
-- a ledger containing the chart of accounts and balances. If the -- a "Ledger", containing the journal plus the tree of all its
-- query includes a depth limit, that will affect the ledger's -- accounts with their subaccount-inclusive and subaccount-exclusive
-- journal but not the ledger's account tree. -- 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 :: Query -> Journal -> Ledger
ledgerFromJournal q j = nullledger{ljournal=j'', laccounts=as} ledgerFromJournal q j = nullledger{ljournal=j'', laccounts=as}
where where