Skip to content

Commit 71388bb

Browse files
[DOCS] Fix the weighed average documentation (#81307) (#81416)
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
1 parent 09d6c9e commit 71388bb

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

docs/reference/aggregations/metrics/weighted-avg-aggregation.asciidoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -207,13 +207,8 @@ Which should look like:
207207

208208
==== Missing values
209209

210-
The `missing` parameter defines how documents that are missing a value should be treated.
211-
The default behavior is different for `value` and `weight`:
212-
213-
By default, if the `value` field is missing the document is ignored and the aggregation moves on to the next document.
214-
If the `weight` field is missing, it is assumed to have a weight of `1` (like a normal average).
215-
216-
Both of these defaults can be overridden with the `missing` parameter:
210+
By default, the aggregation excludes documents with a missing or `null` value for the `value` or `weight` field. Use the
211+
`missing` parameter to specify a default value for these documents instead.
217212

218213
[source,console]
219214
--------------------------------------------------

0 commit comments

Comments
 (0)