Add Docs and Examples and helper methods to PhysicalSortExpr
#12589
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
github-actions
bot
added
physical-expr
alamb
commented
Sep 23, 2024
| nulls_first: true, | ||
| }, | ||
| }, | ||
| PhysicalSortExpr::new_default(physical_col("string_col", &schema).unwrap()) |
There was a problem hiding this comment.
This shows what I would like to be able to do
| @@ -30,6 +30,51 @@ use datafusion_common::Result; | |||
| use datafusion_expr_common::columnar_value::ColumnarValue; | |||
|
|
|||
| /// Represents Sort operation for a column in a RecordBatch | |||
| /// | |||
| /// Example: | |||
There was a problem hiding this comment.
This looks like a massive example but it renders neatly I think:
This was referenced Sep 23, 2024
comphead
approved these changes
Sep 23, 2024
|
Thanks for the quick review @comphead |
bgjackma
pushed a commit
to bgjackma/datafusion
that referenced
this pull request
Sep 25, 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.
Which issue does this PR close?
Part of #12446
Closes #.
Rationale for this change
Basically while working on #12562 I got annoyed at the lack of documentation and display implementations as well as how award it was to create
PhysicalSortExprs.What changes are included in this PR?
Are these changes tested?
Yes, by CI and doc tests
Are there any user-facing changes?
Better docs, easier to use APIs.
No API changes