Improve PhysicalExpr and Column documentation #12457
Merged
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
alamb
commented
Sep 13, 2024
| @@ -31,8 +31,27 @@ use datafusion_expr_common::columnar_value::ColumnarValue; | |||
| use datafusion_expr_common::interval_arithmetic::Interval; | |||
| use datafusion_expr_common::sort_properties::ExprProperties; | |||
|
|
|||
| /// See [create_physical_expr](https://docs.rs/datafusion/latest/datafusion/physical_expr/fn.create_physical_expr.html) | |||
| /// for examples of creating `PhysicalExpr` from `Expr` | |||
| /// [`PhysicalExpr`]s represent expressions such as `A + 1` or `CAST(c1 AS int)`. | |||
There was a problem hiding this comment.
it was strange there was no explanation of what a PhysicalExpr was on the trait, so let's fix that (moved the docs from create_physical_expr and revamped it a bit)
| @@ -33,32 +33,67 @@ use datafusion_expr::ColumnarValue; | |||
| use crate::physical_expr::{down_cast_any_ref, PhysicalExpr}; | |||
|
|
|||
| /// Represents the column at a given index in a RecordBatch | |||
| /// | |||
| /// This is a physical expression that represents a column at a given index in a | |||
There was a problem hiding this comment.
The point that physical exprs are always in terms of indexes wasn't as clear as I think it could be so I tried to improve that
appletreeisyellow
approved these changes
Sep 13, 2024
There was a problem hiding this comment.
Thank you for the doc improvement @alamb! I did found myself digging into doc to find how to create PhysicalExpr from Expr. This improvement will make such kind of process faster. Thank you!
Co-authored-by: Chunchun Ye <[email protected]>
comphead
approved these changes
Sep 13, 2024
|
Thanks for the reviews and merge @jayzhan211 and @comphead |
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 #4028
Rationale for this change
While working with @itsjunetime on #12135
I noticed that the description / documentation of
PhysicalExprwas not as clear as it could be:Columnepr was also not as well documented as it could beWhat changes are included in this PR?
Improve the documentation so this is clearer
Are these changes tested?
By docs CI
Are there any user-facing changes?
No functional changes, only documentation