-
Notifications
You must be signed in to change notification settings - Fork 25
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.
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
Add top/bottom docs. #1048
Add top/bottom docs. #1048
Conversation
search/topbottom/topbottom.md
Outdated
| 10 | 200 | | ||
| 10 | 100 | | ||
|
||
In the example above, `top` took the top two values of `foo` first, and where `foo` had the same value, took the top value of `bar` instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The output will be:
foo | bar |
---|---|
10 | 200 |
10 | 100 |
In the example above, top
took the top two values of foo
first, and where foo
had the same value, took the top value of bar
instead."
I was a little but confused by this example. As I understand it, the small foo bar table in this example is sort of an intermediate step that shows how the processing works but the output will be 10, 200 - just those two values. I would change the language here to represent this small table as an intermediate step (what's happening under the hood) and then say "so the final result will be: "
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No -- the returned data will be two entries. And those two entries each have a foo and bar value. And these are the values on the entries. Additionally it will come back in that order.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotcha! ok. I was still really confused when I read this, so maybe we can clarify in some way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe describe bar
as a tie breaker. Saying "instead" makes me feel like foo
should be discarded in favor of bar
.
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fixes #998