;regen docs

hledger-lib/hledger_journal.5

@@ -601,6 +601,12 @@ In summary: amounts will be displayed much as they appear in your
 journal, with the max observed number of decimal places.
 If you want to see fewer decimal places in reports, use a commodity
 directive to override that.
+.PP
+hledger uses banker\[aq]s rounding: it rounds to the nearest even
+number, eg 0.5 displayed with zero decimal places is \[dq]0\[dq]).
+(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\[aq]s
+guaranteed.)
 .SS Transaction prices
 .PP
 Within a transaction, you can note an amount\[aq]s price in another
@@ -1197,6 +1203,10 @@ The quantity of the amount does not matter; only the format is
 significant.
 The number must include a decimal mark: either a period or a comma,
 followed by 0 or more decimal digits.
+.PP
+Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with
+zero decimal digits is \[dq]0\[dq].
+(More at Amount display style.)
 .SS Default commodity
 .PP
 The \f[C]D\f[R] directive sets a default commodity, to be used for

hledger-lib/hledger_journal.info

@@ -544,6 +544,11 @@ journal, with the max observed number of decimal places.  If you want to
 see fewer decimal places in reports, use a commodity directive to
 override that.
 
+   hledger uses banker's 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.)
+
 
 File: hledger_journal.info,  Node: Transaction prices,  Next: Balance Assertions,  Prev: Amounts,  Up: Transactions
 
@@ -1070,6 +1075,9 @@ commodity INR
 significant.  The number must include a decimal mark: either a period or
 a comma, followed by 0 or more decimal digits.
 
+   Note hledger normally uses banker's rounding, so 0.5 displayed with
+zero decimal digits is "0".  (More at Amount display style.)
+
 
 File: hledger_journal.info,  Node: Default commodity,  Next: Market prices,  Prev: Declaring commodities,  Up: Directives
 
@@ -1821,90 +1829,90 @@ Node: Digit group marks16739
 Ref: #digit-group-marks16887
 Node: Amount display style17825
 Ref: #amount-display-style17979
-Node: Transaction prices19140
+Node: Transaction prices19417
-Ref: #transaction-prices19306
+Ref: #transaction-prices19583
-Node: Balance Assertions21572
+Node: Balance Assertions21849
-Ref: #balance-assertions21752
+Ref: #balance-assertions22029
-Node: Assertions and ordering22785
+Node: Assertions and ordering23062
-Ref: #assertions-and-ordering22973
+Ref: #assertions-and-ordering23250
-Node: Assertions and included files23673
+Node: Assertions and included files23950
-Ref: #assertions-and-included-files23916
+Ref: #assertions-and-included-files24193
-Node: Assertions and multiple -f options24249
+Node: Assertions and multiple -f options24526
-Ref: #assertions-and-multiple--f-options24505
+Ref: #assertions-and-multiple--f-options24782
-Node: Assertions and commodities24637
+Node: Assertions and commodities24914
-Ref: #assertions-and-commodities24869
+Ref: #assertions-and-commodities25146
-Node: Assertions and prices26026
+Node: Assertions and prices26303
-Ref: #assertions-and-prices26240
+Ref: #assertions-and-prices26517
-Node: Assertions and subaccounts26680
+Node: Assertions and subaccounts26957
-Ref: #assertions-and-subaccounts26909
+Ref: #assertions-and-subaccounts27186
-Node: Assertions and virtual postings27233
+Node: Assertions and virtual postings27510
-Ref: #assertions-and-virtual-postings27475
+Ref: #assertions-and-virtual-postings27752
-Node: Assertions and precision27617
+Node: Assertions and precision27894
-Ref: #assertions-and-precision27810
+Ref: #assertions-and-precision28087
-Node: Balance Assignments28077
+Node: Balance Assignments28354
-Ref: #balance-assignments28251
+Ref: #balance-assignments28528
-Node: Balance assignments and prices29415
+Node: Balance assignments and prices29692
-Ref: #balance-assignments-and-prices29587
+Ref: #balance-assignments-and-prices29864
-Node: Directives29811
+Node: Directives30088
-Ref: #directives29970
+Ref: #directives30247
-Node: Directives and multiple files35651
+Node: Directives and multiple files35928
-Ref: #directives-and-multiple-files35834
+Ref: #directives-and-multiple-files36111
-Node: Comment blocks36498
+Node: Comment blocks36775
-Ref: #comment-blocks36681
+Ref: #comment-blocks36958
-Node: Including other files36857
+Node: Including other files37134
-Ref: #including-other-files37037
+Ref: #including-other-files37314
-Node: Default year37445
+Node: Default year37722
-Ref: #default-year37614
+Ref: #default-year37891
-Node: Declaring commodities38021
+Node: Declaring commodities38298
-Ref: #declaring-commodities38204
+Ref: #declaring-commodities38481
-Node: Default commodity39877
+Node: Default commodity40287
-Ref: #default-commodity40053
+Ref: #default-commodity40463
-Node: Market prices40942
+Node: Market prices41352
-Ref: #market-prices41107
+Ref: #market-prices41517
-Node: Declaring accounts41948
+Node: Declaring accounts42358
-Ref: #declaring-accounts42124
+Ref: #declaring-accounts42534
-Node: Account comments43049
+Node: Account comments43459
-Ref: #account-comments43212
+Ref: #account-comments43622
-Node: Account subdirectives43636
+Node: Account subdirectives44046
-Ref: #account-subdirectives43831
+Ref: #account-subdirectives44241
-Node: Account types44144
+Node: Account types44554
-Ref: #account-types44328
+Ref: #account-types44738
-Node: Account display order45967
+Node: Account display order46377
-Ref: #account-display-order46137
+Ref: #account-display-order46547
-Node: Rewriting accounts47288
+Node: Rewriting accounts47698
-Ref: #rewriting-accounts47473
+Ref: #rewriting-accounts47883
-Node: Basic aliases48230
+Node: Basic aliases48640
-Ref: #basic-aliases48376
+Ref: #basic-aliases48786
-Node: Regex aliases49080
+Node: Regex aliases49490
-Ref: #regex-aliases49252
+Ref: #regex-aliases49662
-Node: Combining aliases49970
+Node: Combining aliases50380
-Ref: #combining-aliases50163
+Ref: #combining-aliases50573
-Node: Aliases and multiple files51439
+Node: Aliases and multiple files51849
-Ref: #aliases-and-multiple-files51648
+Ref: #aliases-and-multiple-files52058
-Node: end aliases52227
+Node: end aliases52637
-Ref: #end-aliases52384
+Ref: #end-aliases52794
-Node: Default parent account52485
+Node: Default parent account52895
-Ref: #default-parent-account52653
+Ref: #default-parent-account53063
-Node: Periodic transactions53537
+Node: Periodic transactions53947
-Ref: #periodic-transactions53712
+Ref: #periodic-transactions54122
-Node: Periodic rule syntax55584
+Node: Periodic rule syntax55994
-Ref: #periodic-rule-syntax55790
+Ref: #periodic-rule-syntax56200
-Node: Two spaces between period expression and description!56494
+Node: Two spaces between period expression and description!56904
-Ref: #two-spaces-between-period-expression-and-description56813
+Ref: #two-spaces-between-period-expression-and-description57223
-Node: Forecasting with periodic transactions57497
+Node: Forecasting with periodic transactions57907
-Ref: #forecasting-with-periodic-transactions57802
+Ref: #forecasting-with-periodic-transactions58212
-Node: Budgeting with periodic transactions59828
+Node: Budgeting with periodic transactions60238
-Ref: #budgeting-with-periodic-transactions60067
+Ref: #budgeting-with-periodic-transactions60477
-Node: Auto postings60516
+Node: Auto postings60926
-Ref: #auto-postings60656
+Ref: #auto-postings61066
-Node: Auto postings and multiple files62835
+Node: Auto postings and multiple files63245
-Ref: #auto-postings-and-multiple-files63039
+Ref: #auto-postings-and-multiple-files63449
-Node: Auto postings and dates63248
+Node: Auto postings and dates63658
-Ref: #auto-postings-and-dates63522
+Ref: #auto-postings-and-dates63932
-Node: Auto postings and transaction balancing / inferred amounts / balance assertions63697
+Node: Auto postings and transaction balancing / inferred amounts / balance assertions64107
-Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions64048
+Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions64458
-Node: Auto posting tags64390
+Node: Auto posting tags64800
-Ref: #auto-posting-tags64605
+Ref: #auto-posting-tags65015
 
 End Tag Table
 

hledger-lib/hledger_journal.txt

@@ -429,6 +429,11 @@ FILE FORMAT
        see fewer decimal places in reports, use a commodity directive to over-
        ride that.
 
+       hledger  uses  banker's 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
        Within a transaction, you can note an amount's price in another commod-
        ity.   This can be used to document the cost (in a purchase) or selling
@@ -723,7 +728,6 @@ FILE FORMAT
        number   how to interpret numbers when parsing journal entries (the iden-
        nota-    tity of the decimal separator character).  (Currently each  com-
        tion     modity can have its own notation, even in the same file.)
-
        dis-     how  to  display  amounts of a commodity in reports (symbol side
        play     and spacing, digit groups, decimal separator, decimal places)
        style
@@ -834,6 +838,9 @@ FILE FORMAT
        cant.  The number must include a decimal mark: either  a  period  or  a
        comma, followed by 0 or more decimal digits.
 
+       Note  hledger  normally  uses  banker's rounding, so 0.5 displayed with
+       zero decimal digits is "0".  (More at Amount display style.)
+
    Default commodity
        The D directive sets a default commodity, to be used for amounts  with-
        out a commodity symbol (ie, plain numbers).  This commodity will be ap-

hledger/Hledger/Cli/Commands/Balance.txt

@@ -351,13 +351,14 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                       ||      0 [              0]       0 [              0] 
 
-Note this is different from a normal balance report in several ways:
+This is different from a normal balance report in several ways:
 
 -   Only accounts with budget goals during the report period are shown,
     by default.
 
--   In each column, in square brackets after the actual amount, budgeted
+-   In each column, in square brackets after the actual amount, budget
-    amounts are shown, along with the percentage of budget used.
+    goal amounts are shown, and the actual/goal percentage. (Note:
+    budget goals should be in the same commodity as the actual amount.)
 
 -   All parent accounts are always shown, even in flat mode. Eg assets,
     assets:bank, and expenses above.

hledger/hledger.1

@@ -2838,13 +2838,15 @@ Budget performance in 2017/11/01-2017/12/31:
 \f[R]
 .fi
 .PP
-Note this is different from a normal balance report in several ways:
+This is different from a normal balance report in several ways:
 .IP \[bu] 2
 Only accounts with budget goals during the report period are shown, by
 default.
 .IP \[bu] 2
-In each column, in square brackets after the actual amount, budgeted
+In each column, in square brackets after the actual amount, budget goal
-amounts are shown, along with the percentage of budget used.
+amounts are shown, and the actual/goal percentage.
+(Note: budget goals should be in the same commodity as the actual
+amount.)
 .IP \[bu] 2
 All parent accounts are always shown, even in flat mode.
 Eg assets, assets:bank, and expenses above.

hledger/hledger.info

@@ -2319,14 +2319,14 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                       ||      0 [              0]       0 [              0] 
 
-   Note this is different from a normal balance report in several ways:
+   This is different from a normal balance report in several ways:
 
    * Only accounts with budget goals during the report period are shown,
      by default.
 
-   * In each column, in square brackets after the actual amount,
+   * In each column, in square brackets after the actual amount, budget
-     budgeted amounts are shown, along with the percentage of budget
+     goal amounts are shown, and the actual/goal percentage.  (Note:
-     used.
+     budget goals should be in the same commodity as the actual amount.)
 
    * All parent accounts are always shown, even in flat mode.  Eg
      assets, assets:bank, and expenses above.
@@ -3832,89 +3832,89 @@ Node: Multicolumn balance report73444
 Ref: #multicolumn-balance-report73624
 Node: Budget report78886
 Ref: #budget-report79029
-Node: Nested budgets84231
+Node: Nested budgets84295
-Ref: #nested-budgets84343
+Ref: #nested-budgets84407
-Ref: #output-format-187824
+Ref: #output-format-187888
-Node: balancesheet88021
+Node: balancesheet88085
-Ref: #balancesheet88157
+Ref: #balancesheet88221
-Node: balancesheetequity89623
+Node: balancesheetequity89687
-Ref: #balancesheetequity89772
+Ref: #balancesheetequity89836
-Node: cashflow90495
+Node: cashflow90559
-Ref: #cashflow90623
+Ref: #cashflow90687
-Node: check-dates91802
+Node: check-dates91866
-Ref: #check-dates91929
+Ref: #check-dates91993
-Node: check-dupes92208
+Node: check-dupes92272
-Ref: #check-dupes92332
+Ref: #check-dupes92396
-Node: close92625
+Node: close92689
-Ref: #close92739
+Ref: #close92803
-Node: close usage94261
+Node: close usage94325
-Ref: #close-usage94354
+Ref: #close-usage94418
-Node: commodities97167
+Node: commodities97231
-Ref: #commodities97294
+Ref: #commodities97358
-Node: descriptions97376
+Node: descriptions97440
-Ref: #descriptions97504
+Ref: #descriptions97568
-Node: diff97685
+Node: diff97749
-Ref: #diff97791
+Ref: #diff97855
-Node: files98838
+Node: files98902
-Ref: #files98938
+Ref: #files99002
-Node: help99085
+Node: help99149
-Ref: #help99185
+Ref: #help99249
-Node: import100266
+Node: import100330
-Ref: #import100380
+Ref: #import100444
-Node: Importing balance assignments101273
+Node: Importing balance assignments101337
-Ref: #importing-balance-assignments101421
+Ref: #importing-balance-assignments101485
-Node: incomestatement102070
+Node: incomestatement102134
-Ref: #incomestatement102203
+Ref: #incomestatement102267
-Node: notes103690
+Node: notes103754
-Ref: #notes103803
+Ref: #notes103867
-Node: payees103929
+Node: payees103993
-Ref: #payees104035
+Ref: #payees104099
-Node: prices104193
+Node: prices104257
-Ref: #prices104299
+Ref: #prices104363
-Node: print104640
+Node: print104704
-Ref: #print104750
+Ref: #print104814
-Node: print-unique109536
+Node: print-unique109600
-Ref: #print-unique109662
+Ref: #print-unique109726
-Node: register109947
+Node: register110011
-Ref: #register110074
+Ref: #register110138
-Node: Custom register output114246
+Node: Custom register output114310
-Ref: #custom-register-output114375
+Ref: #custom-register-output114439
-Node: register-match115712
+Node: register-match115776
-Ref: #register-match115846
+Ref: #register-match115910
-Node: rewrite116197
+Node: rewrite116261
-Ref: #rewrite116312
+Ref: #rewrite116376
-Node: Re-write rules in a file118167
+Node: Re-write rules in a file118231
-Ref: #re-write-rules-in-a-file118301
+Ref: #re-write-rules-in-a-file118365
-Node: Diff output format119511
+Node: Diff output format119575
-Ref: #diff-output-format119680
+Ref: #diff-output-format119744
-Node: rewrite vs print --auto120772
+Node: rewrite vs print --auto120836
-Ref: #rewrite-vs.-print---auto120951
+Ref: #rewrite-vs.-print---auto121015
-Node: roi121507
+Node: roi121571
-Ref: #roi121605
+Ref: #roi121669
-Node: stats122617
+Node: stats122681
-Ref: #stats122716
+Ref: #stats122780
-Node: tags123504
+Node: tags123568
-Ref: #tags123602
+Ref: #tags123666
-Node: test123896
+Node: test123960
-Ref: #test124004
+Ref: #test124068
-Node: Add-on Commands124751
+Node: Add-on Commands124815
-Ref: #add-on-commands124868
+Ref: #add-on-commands124932
-Node: ui126211
+Node: ui126275
-Ref: #ui126299
+Ref: #ui126363
-Node: web126353
+Node: web126417
-Ref: #web126456
+Ref: #web126520
-Node: iadd126572
+Node: iadd126636
-Ref: #iadd126683
+Ref: #iadd126747
-Node: interest126765
+Node: interest126829
-Ref: #interest126872
+Ref: #interest126936
-Node: ENVIRONMENT127112
+Node: ENVIRONMENT127176
-Ref: #environment127224
+Ref: #environment127288
-Node: FILES128053
+Node: FILES128117
-Ref: #files-1128156
+Ref: #files-1128220
-Node: LIMITATIONS128369
+Node: LIMITATIONS128433
-Ref: #limitations128488
+Ref: #limitations128552
-Node: TROUBLESHOOTING129230
+Node: TROUBLESHOOTING129294
-Ref: #troubleshooting129343
+Ref: #troubleshooting129407
 
 End Tag Table
 

hledger/hledger.txt

@@ -1995,13 +1995,14 @@ COMMANDS
               ----------------------++----------------------------------------------------
                                     ||      0 [              0]       0 [              0]
 
-       Note this is different from a normal balance report in several ways:
+       This is different from a normal balance report in several ways:
 
        o Only  accounts  with budget goals during the report period are shown,
          by default.
 
-       o In each column, in square brackets after the actual amount,  budgeted
+       o In each column, in square brackets after the  actual  amount,  budget
-         amounts are shown, along with the percentage of budget used.
+         goal  amounts are shown, and the actual/goal percentage.  (Note: bud-
+         get goals should be in the same commodity as the actual amount.)
 
        o All parent accounts are always shown, even in flat mode.  Eg  assets,
          assets:bank, and expenses above.