builtins: update description of format_int to say it rounds down

Signed-off-by: Anders Eknert <anders@eknert.com>
open-policy-agent · Sep 7, 2022 · 3ed3643 · 3ed3643
1 parent b5cbbb5
commit 3ed3643
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/ast/builtins.go b/ast/builtins.go
@@ -1021,7 +1021,7 @@ var Concat = &Builtin{
 
 var FormatInt = &Builtin{
 	Name:        "format_int",
-	Description: "Returns the string representation of the number in the given base after converting it to an integer value.",
+	Description: "Returns the string representation of the number in the given base after rounding it down to an integer value.",
 	Decl: types.NewFunction(
 		types.Args(
 			types.Named("number", types.N).Description("number to format"),

diff --git a/builtin_metadata.json b/builtin_metadata.json
@@ -3718,7 +3718,7 @@
       "v0.43.0",
       "edge"
     ],
-    "description": "Returns the string representation of the number in the given base after converting it to an integer value.",
+    "description": "Returns the string representation of the number in the given base after rounding it down to an integer value.",
     "introduced": "v0.17.0",
     "result": {
       "description": "formatted number",