haddock

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
 -- 

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
+from a 'RawLedger' for easier querying. Also it typically has had
-uninteresting 'LedgerTransaction's and 'Posting's removed. It contains
+uninteresting 'LedgerTransaction's and 'Posting's filtered out. It
+contains:
 
-- the original 'RawLedger'
+- the original unfiltered 'RawLedger'
 
 - a tree of 'AccountName's
 

Ledger/Posting.hs

@@ -1,7 +1,11 @@
 {-|
 
-A 'Posting' represents a single transaction line within a ledger
+A 'Posting' represents a 'MixedAmount' being added to or subtracted from a
-entry. We call it raw to distinguish from the cached 'Transaction'.
+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'.
 
 -}
 

Ledger/TimeLog.hs

@@ -1,8 +1,8 @@
 {-|
 
-A 'TimeLog' is a parsed timelog file (see timeclock.el or the command-line
+A 'TimeLogEntry' is a clock-in, clock-out, or other directive in a timelog
-version) containing zero or more 'TimeLogEntry's. It can be converted to a
+file (see timeclock.el or the command-line version). These can be
-'RawLedger' for querying.
+converted to 'LedgerTransactions' and queried like a ledger.
 
 -}
 

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
+  - hledger 0.4 had Entrys containing RawTransactions, plus Transactions
-    which are a RawTransaction with its parent Entry's info added.
+    which were a RawTransaction with its parent Entry's info added.
-    Transactions are what we most work with when reporting and are
+    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).
+  - hledger 0.5 has LedgerTransactions containing Postings, plus
-    These could be named PartialTransactions or TransactionPostings, but
+    Transactions as before (a Posting plus it's parent's info).  The
-    it gets too verbose and obscure for devs and users.
+    \"transaction\" term is pretty ingrained in the code, docs and with
+    users, so we've kept it. 
 
 -}