From b9ba92d10525c9a7e5205dcea532d42e858111be Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 30 May 2013 15:26:34 -0700 Subject: [PATCH] docs: update manual and faq with latest balance assertions info --- FAQ.md | 5 +++++ MANUAL.md | 13 +++++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/FAQ.md b/FAQ.md index 0557e1565..74222dbae 100644 --- a/FAQ.md +++ b/FAQ.md @@ -195,6 +195,11 @@ comments may be permissible in different places. - hledger's [include directive](MANUAL.html#including-other-files) does not support shell glob patterns (eg `include *.journal` ), which ledger does. +- when checking [balance assertions](MANUAL.html#balance-assertions) + hledger sorts the account's postings first by date and then (for + postings with the same date) by parse order. ledger goes strictly by + parse order. + ### How are the implementations different ? ledger is written in C++, whereas hledger is written in the diff --git a/MANUAL.md b/MANUAL.md index 9ce348aab..ca89a16b8 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -263,11 +263,16 @@ each posting: After reading a journal file, hledger will check all balance assertions and report an error if any of them fail. Balance assertions can protect you from, eg, inadvertently disrupting reconciled balances -while cleaning up old entries. Some tips: +while cleaning up old entries. -- balance assertions depend on the order postings are parsed from the file(s). The posting's date is ignored, currently. -- balance assertion amounts currently must have a commodity symbol. -- balance assertions' impact on parsing time for large files is not yet known. +Note, when checking balance assertions hledger sorts the account's +postings first by date and then (for postings with the same date) by +parse order. This is different from ledger, which currently goes +strictly by parse order. Sorting by date means balance assertions will +still work if you reorder your entries. + +The impact of balance assertions on parsing time for large files is +not yet known. #### Prices