elasticsearch/docs/reference/esql/functions/parameters/round.asciidoc

// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

*Parameters*

`number`::
The numeric value to round. If `null`, the function returns `null`.

`decimals`::
The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`.
ESQL: Generate docs for the trig functions (#106891) This updates the in-code docs on the trig functions to line up with the docs, removes the docs, and uses the now mostly identical generated docs. This means we only need to document these functions in one place - right next to the code. 2024-03-30 00:24:31 +08:00			`// This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`

ESQL: Generate more docs (#106367) This modifies the ESQL test infrastructure to generate more of the documentation for functions. It generates the Description section, the Examples section, and the Parameters section as separate files so we can use them as needed. It also generates a `layout` file that's just a guess as to how to render the whole thing. In some cases it'll work and we can use that instead of hand maintaining a "top level" description file for the function. Most newly generated files are unused. We have to chose to pick them up by replacing the sections we were manually maintaining with an include of the generated section. Or by replacing the entire hand maintained file with the generated top level file. Relates to #104247 2024-03-20 03:40:13 +08:00			`Parameters`

ESQL: Use generated docs for abs and acos (#106510) ESQL: Use generated docs for abs and acos 2024-03-21 04:32:12 +08:00			`number`::
ESQL: Improve tests and docs for some functions (#107331) This improves the tests and docs for a few functions, specifically `E`, `FLOOR`, `PI`, `POW`, and `ROUND`. The examples and tested signatures will get copied into the docs and kibana signatures. Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> 2024-04-12 00:41:56 +08:00			The numeric value to round. If `null`, the function returns `null`.
ESQL: Generate more docs (#106367) This modifies the ESQL test infrastructure to generate more of the documentation for functions. It generates the Description section, the Examples section, and the Parameters section as separate files so we can use them as needed. It also generates a `layout` file that's just a guess as to how to render the whole thing. In some cases it'll work and we can use that instead of hand maintaining a "top level" description file for the function. Most newly generated files are unused. We have to chose to pick them up by replacing the sections we were manually maintaining with an include of the generated section. Or by replacing the entire hand maintained file with the generated top level file. Relates to #104247 2024-03-20 03:40:13 +08:00
			`decimals`::
ESQL: Improve tests and docs for some functions (#107331) This improves the tests and docs for a few functions, specifically `E`, `FLOOR`, `PI`, `POW`, and `ROUND`. The examples and tested signatures will get copied into the docs and kibana signatures. Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> 2024-04-12 00:41:56 +08:00			The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`.