slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: haddock tweaks

Browse Source
This commit is contained in:
Simon Michael 2011-04-29 03:25:52 +00:00
parent 30b21cce87
commit 92777edc99
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
hledger-lib/Hledger/Data/Types.hs
View File

@ -4,15 +4,15 @@
Most data types are defined here to avoid import cycles. Most data types are defined here to avoid import cycles.
Here is an overview of the hledger data model: 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.. > [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 > [HistoricalPrice] -- historical commodity prices
> >
> Ledger -- a ledger is derived from a journal, by applying a filter specification and doing some further processing. It contains.. > 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 > Journal -- a filtered copy of the original journal, containing only the transactions and postings we are interested in
> Tree AccountName -- account names referenced in the journal's transactions, as a tree > Tree AccountName -- all accounts named by the journal's transactions, as a hierarchy
> Map AccountName Account -- per-account postings and balances from the journal's transactions, as a map from account name to account info > Map AccountName Account -- the postings, and resulting balances, in each account
For more detailed documentation on each type, see the corresponding modules. For more detailed documentation on each type, see the corresponding modules.

2
hledger/Hledger/Cli/Add.hs
View File

@ -3,7 +3,7 @@
A history-aware add command to help with data entry. A history-aware add command to help with data entry.
Note: this might not be sensible, but add has some aspirations of being 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. informational messages are mostly written to stderr rather than stdout.
-} -}