docs: hledger-lib module haddock updates

hledger-lib/Hledger/Data.hs

@@ -2,7 +2,7 @@
 
 The Ledger library allows parsing and querying of ledger files.  It
 generally provides a compatible subset of C++ ledger's functionality.
-This package re-exports all the Ledger.* modules.
+This package re-exports all the Hledger.Data.* modules.
 
 -}
 

hledger-lib/Hledger/Data/Account.hs

@@ -1,6 +1,6 @@
 {-|
 
-A compound data type for efficiency. An 'Account' stores
+An 'Account' stores
 
 - an 'AccountName',
 

hledger-lib/Hledger/Data/AccountName.hs

@@ -1,8 +1,9 @@
 {-# LANGUAGE NoMonomorphismRestriction#-}
 {-|
 
-'AccountName's are strings like @assets:cash:petty@.
-From a set of these we derive the account hierarchy.
+'AccountName's are strings like @assets:cash:petty@, with multiple
+components separated by ':'.  From a set of these we derive the account
+hierarchy.
 
 -}
 

hledger-lib/Hledger/Data/Journal.hs

@@ -1,7 +1,8 @@
 {-|
 
 A 'Journal' is a set of 'Transaction's and related data, usually parsed
-from a hledger/ledger journal file or timelog.
+from a hledger/ledger journal file or timelog. This is the primary hledger
+data object.
 
 -}
 

hledger-lib/Hledger/Data/Parse.hs

@@ -1,7 +1,7 @@
 {-# LANGUAGE CPP #-}
 {-|
 
-Parsers for standard ledger and timelog files.
+Parsers for hledger's journal file format and the timelog file format.
 
 Here is the ledger grammar from the ledger 2.5 manual:
 

hledger-lib/Hledger/Data/Posting.hs

@@ -4,6 +4,7 @@ A 'Posting' represents a 'MixedAmount' being added to or subtracted from a
 single 'Account'.  Each 'Transaction' contains two or more postings which
 should add up to 0. Postings also reference their parent transaction, so
 we can get a date or description for a posting (from the transaction).
+Strictly speaking, \"entry\" is probably a better name for these.
 
 -}
 

hledger-lib/Hledger/Data/Transaction.hs

@@ -1,7 +1,8 @@
 {-|
 
-A 'Transaction' represents a single balanced entry in the ledger file. It
-normally contains two or more balanced 'Posting's.
+A 'Transaction' consists of two or more related 'Posting's which balance
+to zero, representing a movement of some commodity(ies) between accounts,
+plus a date and optional metadata like description and cleared status.
 
 -}
 

hledger-lib/Hledger/Data/Types.hs

@@ -16,7 +16,7 @@ Here is an overview of the hledger data model:
 
 For more detailed documentation on each type, see the corresponding modules.
 
-Evolution of transaction/entry/posting terminology:
+Evolution of transaction\/entry\/posting terminology:
 
   - ledger 2:    entries contain transactions
 

hledger-lib/Hledger/Data/Utils.hs

@@ -1,8 +1,8 @@
 {-# LANGUAGE CPP #-}
 {-|
 
-Provide standard imports and utilities which are useful everywhere, or
-needed low in the module hierarchy. This is the bottom of the dependency graph.
+Standard imports and utilities which are useful everywhere, or needed low
+in the module hierarchy. This is the bottom of hledger's module graph.
 
 -}