Skip to content

[DOCS] Fix the weighed average documentation #81307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 3, 2021
Merged

[DOCS] Fix the weighed average documentation #81307

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a113af
[DOCS] Fix the weighet average documentation
salvatore-campagna Dec 3, 2021
de3fed9
Fix surrounding text and make it shorter
salvatore-campagna Dec 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/reference/aggregations/metrics/weighted-avg-aggregation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,7 @@ Which should look like:
The `missing` parameter defines how documents that are missing a value should be treated.
The default behavior is different for `value` and `weight`:

By default, if the `value` field is missing the document is ignored and the aggregation moves on to the next document.
If the `weight` field is missing, it is assumed to have a weight of `1` (like a normal average).
By default, if the `value` or `weight` field is missing the document is ignored and the aggregation moves on to the next document.

Both of these defaults can be overridden with the `missing` parameter:
Copy link
Contributor

@jrodewig jrodewig Dec 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the text surrounding this change is still incorrect. For example:

The default behavior is different for value and weight:

is still wrong.

I left a suggestion that fixes up the surrounding text and shortens this a bit. I also updated the text to mention null values, which are treated the same as missing values based on my testing. Feel free to change the wording or let me know what you think.

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


Expand Down