summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/lang/FormatNumberCustom.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/lang/FormatNumberCustom.md')
-rw-r--r--docs/content/en/functions/lang/FormatNumberCustom.md25
1 files changed, 9 insertions, 16 deletions
diff --git a/docs/content/en/functions/lang/FormatNumberCustom.md b/docs/content/en/functions/lang/FormatNumberCustom.md
index 97b022567..0b72f4983 100644
--- a/docs/content/en/functions/lang/FormatNumberCustom.md
+++ b/docs/content/en/functions/lang/FormatNumberCustom.md
@@ -1,31 +1,26 @@
---
title: lang.FormatNumberCustom
description: Returns a numeric representation of a number with the given precision using negative, decimal, and grouping options.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: []
+ related:
+ - functions/lang/FormatAccounting
+ - functions/lang/FormatCurrency
+ - functions/lang/FormatNumber
+ - functions/lang/FormatPercent
returnType: string
signatures: ['lang.FormatNumberCustom PRECISION NUMBER [OPTIONS...]']
-relatedFunctions:
- - lang.FormatAccounting
- - lang.FormatCurrency
- - lang.FormatNumber
- - lang.FormatNumberCustom
- - lang.FormatPercent
aliases: ['/functions/numfmt/']
---
This function formats a number with the given precision. The first options parameter is a space-delimited string of characters to represent negativity, the decimal point, and grouping. The default value is `- . ,`. The second options parameter defines an alternate delimiting character.
-Note that numbers are rounded up at 5 or greater. So, with precision set to 0, 1.5 becomes 2, and 1.4 becomes 1.
+Note that numbers are rounded up at 5 or greater. So, with precision set to 0, 1.5 becomes 2, and 1.4 becomes 1.
For a simpler function that adapts to the current language, see [`lang.FormatNumber`].
-
```go-html-template
{{ lang.FormatNumberCustom 2 12345.6789 }} → 12,345.68
{{ lang.FormatNumberCustom 2 12345.6789 "- , ." }} → 12.345,68
@@ -34,8 +29,6 @@ For a simpler function that adapts to the current language, see [`lang.FormatNum
{{ lang.FormatNumberCustom 0 -12345.6789 "-|.| " "|" }} → -12 346
```
-{{% note %}}
-{{% readfile file="/functions/_common/locales.md" %}}
-{{% /note %}}
+{{% include "functions/_common/locales.md" %}}
[`lang.FormatNumber`]: /functions/lang/formatnumber