github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Clarify "precision" in currency format functions

Browse source 
The documentation of the FormatAccounting and FormatCurrency
functions could be clearer in terms of how the precision param
works. This commit makes it more explicit that adding a precision
of < 2 will not format the return values to include fewer decimals.

Resolves #8858
This commit is contained in:
Paul Gottschling 2021-09-01 20:26:42 -04:00 committed by Bjørn Erik Pedersen
parent b49da33280
commit a864ffe9ac
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
tpl/lang/lang.go
View file

@ -80,8 +80,10 @@ func (ns *Namespace) FormatPercent(precision, number interface{}) (string, error
return ns.translator.FmtPercent(n, p), nil return ns.translator.FmtPercent(n, p), nil
} }
// FormatCurrency returns the currency reprecentation of number for the given currency and precision // FormatCurrency returns the currency representation of number for the given currency and precision
// for the current language. // for the current language.
//
// The return value is formatted with at least two decimal places.
func (ns *Namespace) FormatCurrency(precision, currency, number interface{}) (string, error) { func (ns *Namespace) FormatCurrency(precision, currency, number interface{}) (string, error) {
p, n, err := ns.castPrecisionNumber(precision, number) p, n, err := ns.castPrecisionNumber(precision, number)
if err != nil { if err != nil {
@ -94,8 +96,10 @@ func (ns *Namespace) FormatCurrency(precision, currency, number interface{}) (st
return ns.translator.FmtCurrency(n, p, c), nil return ns.translator.FmtCurrency(n, p, c), nil
} }
// FormatAccounting returns the currency reprecentation of number for the given currency and precision // FormatAccounting returns the currency representation of number for the given currency and precision
// for the current language in accounting notation. // for the current language in accounting notation.
//
// The return value is formatted with at least two decimal places.
func (ns *Namespace) FormatAccounting(precision, currency, number interface{}) (string, error) { func (ns *Namespace) FormatAccounting(precision, currency, number interface{}) (string, error) {
p, n, err := ns.castPrecisionNumber(precision, number) p, n, err := ns.castPrecisionNumber(precision, number)
if err != nil { if err != nil {