From 92777edc99805b859460c25e3aa67263c2706c76 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 29 Apr 2011 03:25:52 +0000 Subject: [PATCH] docs: haddock tweaks --- hledger-lib/Hledger/Data/Types.hs | 10 +++++----- hledger/Hledger/Cli/Add.hs | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/hledger-lib/Hledger/Data/Types.hs b/hledger-lib/Hledger/Data/Types.hs index 8dc0b9c8f..d0da66d53 100644 --- a/hledger-lib/Hledger/Data/Types.hs +++ b/hledger-lib/Hledger/Data/Types.hs @@ -4,15 +4,15 @@ Most data types are defined here to avoid import cycles. Here is an overview of the hledger data model: -> Journal -- a journal is derived from one or more data files. It contains.. +> Journal -- a journal is read from one or more data files. It contains.. > [Transaction] -- journal transactions, which have date, status, code, description and.. -> [Posting] -- multiple account postings (entries), which have account name and amount. +> [Posting] -- multiple account postings (entries), which have account name and amount > [HistoricalPrice] -- historical commodity prices > > Ledger -- a ledger is derived from a journal, by applying a filter specification and doing some further processing. It contains.. -> Journal -- the filtered journal, containing only the transactions and postings we are interested in -> Tree AccountName -- account names referenced in the journal's transactions, as a tree -> Map AccountName Account -- per-account postings and balances from the journal's transactions, as a map from account name to account info +> Journal -- a filtered copy of the original journal, containing only the transactions and postings we are interested in +> Tree AccountName -- all accounts named by the journal's transactions, as a hierarchy +> Map AccountName Account -- the postings, and resulting balances, in each account For more detailed documentation on each type, see the corresponding modules. diff --git a/hledger/Hledger/Cli/Add.hs b/hledger/Hledger/Cli/Add.hs index 072173e14..2aa614a15 100644 --- a/hledger/Hledger/Cli/Add.hs +++ b/hledger/Hledger/Cli/Add.hs @@ -3,7 +3,7 @@ A history-aware add command to help with data entry. Note: this might not be sensible, but add has some aspirations of being -both user-fiendly and pipeable/scriptable and for this reason +both user-friendly and pipeable/scriptable and for this reason informational messages are mostly written to stderr rather than stdout. -}