docs: I don't think journalCanonicaliseAmounts affects price amounts

This commit is contained in:
Simon Michael 2012-01-03 08:17:04 +00:00
parent 13e0757670
commit 470155dc63

View File

@ -279,11 +279,10 @@ journalBalanceTransactions j@Journal{jtxns=ts} =
Left e -> Left e Left e -> Left e
where balance = balanceTransaction (Just $ journalCanonicalCommodities j) where balance = balanceTransaction (Just $ journalCanonicalCommodities j)
-- | Convert all the journal's amounts to their canonical display -- | Convert all the journal's posting amounts (not price amounts) to
-- settings. Ie, all amounts in a given commodity will use (a) the -- their canonical display settings. Ie, all amounts in a given
-- display settings of the first, and (b) the greatest precision, of the -- commodity will use (a) the display settings of the first, and (b)
-- amounts in that commodity. Prices are canonicalised as well, so consider -- the greatest precision, of the posting amounts in that commodity.
-- calling journalApplyHistoricalPrices before this.
journalCanonicaliseAmounts :: Journal -> Journal journalCanonicaliseAmounts :: Journal -> Journal
journalCanonicaliseAmounts j@Journal{jtxns=ts} = j{jtxns=map fixtransaction ts} journalCanonicaliseAmounts j@Journal{jtxns=ts} = j{jtxns=map fixtransaction ts}
where where