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

;journal: document banker's rounding behaviour

Browse Source
This commit is contained in:
Simon Michael 2020-03-19 14:24:57 -07:00
parent 9631ca561c
commit 495dfa37a4
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
hledger-lib/hledger_journal.m4.md
View File

@ -496,8 +496,17 @@ problems, use a commodity directive to fix the display style.
In summary: amounts will be displayed much as they appear in your In summary: amounts will be displayed much as they appear in your
journal, with the max observed number of decimal places. If you want journal, with the max observed number of decimal places. If you want
to see fewer decimal places in reports, use a commodity directive to to see fewer decimal places in reports, use a
override that. [commodity directive](#declaring-commodities)
to override that.
hledger uses [banker's rounding](https://en.wikipedia.org/wiki/Bankers_rounding):
it rounds to the nearest even number, eg 0.5 displayed with zero
decimal places is "0").
(Note, prior to hledger 1.17.1 this could vary if hledger happened to
be built with an old version of Decimal (<0.5.1); since 1.17.1 it's
guaranteed.)
## Transaction prices ## Transaction prices
@ -933,6 +942,11 @@ The quantity of the amount does not matter; only the format is
significant. The number must include a decimal mark: either a period significant. The number must include a decimal mark: either a period
or a comma, followed by 0 or more decimal digits. or a comma, followed by 0 or more decimal digits.
Note hledger normally uses
[banker's rounding](https://en.wikipedia.org/wiki/Bankers_rounding),
so 0.5 displayed with zero decimal digits is "0".
(More at [Amounts](#amounts).)
### Default commodity ### Default commodity
The `D` directive sets a default commodity, to be used for amounts without a commodity symbol (ie, plain numbers). The `D` directive sets a default commodity, to be used for amounts without a commodity symbol (ie, plain numbers).