Improve PhysicalExpr documentation #9180
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
github-actions
bot
added
physical-expr
alamb
commented
Feb 9, 2024
| /// | ||
| /// # Example: Create `PhysicalExpr` from `Expr` | ||
| /// ``` | ||
| /// # use arrow_schema::{DataType, Field, Schema}; |
There was a problem hiding this comment.
This looks pretty terrible in source form, but it renders reasonably I think
comphead
approved these changes
Feb 9, 2024
appletreeisyellow
approved these changes
Feb 9, 2024
|
This is mostly annoyance driven development -- when I am annoyed about an API as a user, I want to fix / make it easier to use :) |
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 #7013
Rationale for this change
I was working on another example, and I wanted to create a
PhysicalExprbut could not figure out how to do so easily from the docs (I had to go poking around in the code)Thus I wanted to provide improved documentation for myself (and I suspect others)
What changes are included in this PR?
PhysicalExprPhysicalExprand how to execute itAre these changes tested?
Are there any user-facing changes?
Docs