Skip to content
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

Merged
merged 10 commits into from
Jul 12, 2024
Merged

Add top/bottom docs. #1048

merged 10 commits into from
Jul 12, 2024

Conversation

david-fritz-gravwell
Copy link
Contributor

Fixes #998

search/topbottom/topbottom.md Outdated Show resolved Hide resolved
search/topbottom/topbottom.md Outdated Show resolved Hide resolved
search/topbottom/topbottom.md Outdated Show resolved Hide resolved
search/topbottom/topbottom.md Outdated Show resolved Hide resolved
| 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.
Copy link
Collaborator

@ashnwade ashnwade Jul 12, 2024

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: "

Copy link
Contributor Author

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.

Copy link
Collaborator

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?

Copy link
Collaborator

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.

search/topbottom/topbottom.md Outdated Show resolved Hide resolved
search/topbottom/topbottom.md Outdated Show resolved Hide resolved
search/topbottom/topbottom.md Outdated Show resolved Hide resolved
david-fritz-gravwell and others added 5 commits July 12, 2024 11:22
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>
@ashnwade ashnwade added this to the v5.5.0 milestone Jul 12, 2024
Copy link
Collaborator

@ashnwade ashnwade left a comment

Choose a reason for hiding this comment

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

LGTM

@ashnwade ashnwade merged commit f0ad030 into gravwell:dev Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants