Skip to content

Commit 1333ea8

Browse files
authored
[ES|QL] Specify population in StdDev docs (#129225)
There are 2 types of Standard Deviation: population and sample, this commit clarifies that the existing is population.
1 parent d592605 commit 1333ea8

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

docs/reference/query-languages/esql/_snippets/functions/description/std_dev.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/examples/std_dev.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/definition/functions/std_dev.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/docs/functions/std_dev.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/StdDev.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ public class StdDev extends AggregateFunction implements ToAggregator {
3737

3838
@FunctionInfo(
3939
returnType = "double",
40-
description = "The standard deviation of a numeric field.",
40+
description = "The population standard deviation of a numeric field.",
4141
type = FunctionType.AGGREGATE,
4242
examples = {
4343
@Example(file = "stats", tag = "stdev"),
4444
@Example(
45-
description = "The expression can use inline functions. For example, to calculate the standard "
45+
description = "The expression can use inline functions. For example, to calculate the population standard "
4646
+ "deviation of each employee’s maximum salary changes, first use `MV_MAX` on each row, "
4747
+ "and then use `STD_DEV` on the result",
4848
file = "stats",

0 commit comments

Comments
 (0)