Add summarize docs for "by" without an aggregate function #5216
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
philrz
commented
Aug 13, 2024
Comment on lines
+8
to
+12
| [summarize] [<field>:=]<agg> | ||
| [summarize] [<field>:=]<agg> [where <expr>][, [<field>:=]<agg> [where <expr>] ...] | ||
| [summarize] [<field>:=]<agg> [by [<field>][:=<expr>][, [<field>][:=<expr>]] ...] | ||
| [summarize] [<field>:=]<agg> [where <expr>][, [<field>:=]<agg> [where <expr>] ...] [by [<field>][:=<expr>][, [<field>][:=<expr>]] ...] | ||
| [summarize] by [<field>][:=<expr>][, [<field>][:=<expr>] ...] |
There was a problem hiding this comment.
After seeing the first iteration of this PR, @nwt correctly pointed out that the expanded/corrected original synopsis line was way too long and complex. His first thought on how to improve it was to break it out into more lines, so that's what I've done on this next iteration and indeed I'm liking it more. I like leading with the shorter one that represents a very common use, then builds up to the full/beastly one, so if a user is learning incrementally hopefully they'll get the idea.
nwt
approved these changes
Aug 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A recent community Slack thread made me realize we were lacking usage docs and an example for
byin the absence of an aggregate function.While I was making this change, I saw that the existing
bycoverage didn't seem to show that multiple keys could be specified, so I've tried to address that as well.