From ca16e9865593ded7afe3b66e7f461ff1f28b941a Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 4 Apr 2009 23:15:42 +0000 Subject: [PATCH] haddock --- Ledger/IO.hs | 4 ++-- Ledger/Ledger.hs | 7 ++++--- Ledger/Posting.hs | 8 ++++++-- Ledger/TimeLog.hs | 6 +++--- Ledger/Types.hs | 17 +++++++++-------- 5 files changed, 24 insertions(+), 18 deletions(-) diff --git a/Ledger/IO.hs b/Ledger/IO.hs index 1ce0b37c6..030665b90 100644 --- a/Ledger/IO.hs +++ b/Ledger/IO.hs @@ -28,9 +28,9 @@ timelogenvvar = "TIMELOG" -- -- - only include transactions in this date span -- --- - only include if cleared/uncleared/don't care +-- - only include if cleared\/uncleared\/don't care -- --- - only include if real/don't care +-- - only include if real\/don't care -- -- - convert all amounts to cost basis -- diff --git a/Ledger/Ledger.hs b/Ledger/Ledger.hs index df4795533..2a438a360 100644 --- a/Ledger/Ledger.hs +++ b/Ledger/Ledger.hs @@ -1,10 +1,11 @@ {-| A compound data type for efficiency. A 'Ledger' caches information derived -from a 'RawLedger' so that it is easy to query. It typically has had -uninteresting 'LedgerTransaction's and 'Posting's removed. It contains +from a 'RawLedger' for easier querying. Also it typically has had +uninteresting 'LedgerTransaction's and 'Posting's filtered out. It +contains: -- the original 'RawLedger' +- the original unfiltered 'RawLedger' - a tree of 'AccountName's diff --git a/Ledger/Posting.hs b/Ledger/Posting.hs index f5b3ef43c..8a0f9adb7 100644 --- a/Ledger/Posting.hs +++ b/Ledger/Posting.hs @@ -1,7 +1,11 @@ {-| -A 'Posting' represents a single transaction line within a ledger -entry. We call it raw to distinguish from the cached 'Transaction'. +A 'Posting' represents a 'MixedAmount' being added to or subtracted from a +single 'Account'. Each 'LedgerTransaction' contains two or more postings +which should add up to 0. + +Generally, we use these with the ledger transaction's date and description +added, which we call a 'Transaction'. -} diff --git a/Ledger/TimeLog.hs b/Ledger/TimeLog.hs index 272b5c494..e5d5541dc 100644 --- a/Ledger/TimeLog.hs +++ b/Ledger/TimeLog.hs @@ -1,8 +1,8 @@ {-| -A 'TimeLog' is a parsed timelog file (see timeclock.el or the command-line -version) containing zero or more 'TimeLogEntry's. It can be converted to a -'RawLedger' for querying. +A 'TimeLogEntry' is a clock-in, clock-out, or other directive in a timelog +file (see timeclock.el or the command-line version). These can be +converted to 'LedgerTransactions' and queried like a ledger. -} diff --git a/Ledger/Types.hs b/Ledger/Types.hs index 96733d5d1..cb5e559ce 100644 --- a/Ledger/Types.hs +++ b/Ledger/Types.hs @@ -3,21 +3,22 @@ Most data types are defined here to avoid import cycles. See the corresponding modules for each type's documentation. -A note about entry/transaction/posting terminology: +A note about entry\/transaction\/posting terminology: - ledger 2 had Entrys containing Transactions. - - hledger 0.4 had Entrys containing RawTransactions, and Transactions - which are a RawTransaction with its parent Entry's info added. - Transactions are what we most work with when reporting and are + - hledger 0.4 had Entrys containing RawTransactions, plus Transactions + which were a RawTransaction with its parent Entry's info added. + The latter are what we most work with when reporting and are ubiquitous in the code and docs. - ledger 3 has Transactions containing Postings. - - hledger 0.5 has LedgerTransactions containing Postings, with - Transactions kept as before (a Posting plus it's parent's info). - These could be named PartialTransactions or TransactionPostings, but - it gets too verbose and obscure for devs and users. + + - hledger 0.5 has LedgerTransactions containing Postings, plus + Transactions as before (a Posting plus it's parent's info). The + \"transaction\" term is pretty ingrained in the code, docs and with + users, so we've kept it. -}