Skip to content

Commit fc4d63c

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

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

docs/reference/esql/functions/description/std_dev.asciidoc

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/esql/functions/examples/std_dev.asciidoc

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/esql/functions/kibana/definition/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/esql/functions/kibana/docs/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
@@ -36,12 +36,12 @@ public class StdDev extends AggregateFunction implements ToAggregator {
3636

3737
@FunctionInfo(
3838
returnType = "double",
39-
description = "The standard deviation of a numeric field.",
39+
description = "The population standard deviation of a numeric field.",
4040
isAggregation = true,
4141
examples = {
4242
@Example(file = "stats", tag = "stdev"),
4343
@Example(
44-
description = "The expression can use inline functions. For example, to calculate the standard "
44+
description = "The expression can use inline functions. For example, to calculate the population standard "
4545
+ "deviation of each employee's maximum salary changes, first use `MV_MAX` on each row, "
4646
+ "and then use `STD_DEV` on the result",
4747
file = "stats",

0 commit comments

Comments
 (0)