Minor: refine Partitioning documentation #12145
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
logical-expr
alamb
commented
Aug 24, 2024
| @@ -24,8 +24,8 @@ use crate::{physical_exprs_equal, EquivalenceProperties, PhysicalExpr}; | |||
|
|
|||
| /// Output partitioning supported by [`ExecutionPlan`]s. | |||
| /// | |||
| /// When `executed`, `ExecutionPlan`s produce one or more independent stream of | |||
| /// data batches in parallel, referred to as partitions. The streams are Rust | |||
| /// Calling [`ExecutionPlan::execute`] produce one or more independent streams of | |||
There was a problem hiding this comment.
This was a driveby cleanup
| /// Logical partitioning schemes supported by the repartition operator. | ||
| /// Logical partitioning schemes supported by [`LogicalPlan::Repartition`] | ||
| /// | ||
| /// See [`Partitioning`] for more details on partitioning |
There was a problem hiding this comment.
the main reason for this PR is to add this link
comphead
reviewed
Aug 24, 2024
| /// When `executed`, `ExecutionPlan`s produce one or more independent stream of | ||
| /// data batches in parallel, referred to as partitions. The streams are Rust | ||
| /// Calling [`ExecutionPlan::execute`] produce one or more independent streams of | ||
| /// [`RecordBatch`]es in parallel, referred to as partitions. The streams are Rust | ||
| /// `async` [`Stream`]s (a special kind of future). The number of output |
There was a problem hiding this comment.
perhaps we can add the link to the futures-core crate which backs streams ?
There was a problem hiding this comment.
I double checked by building the docs locally
This link looks like this:
And it goes to this link:
https://docs.rs/futures/latest/futures/stream/trait.Stream.html
Is that what you mean by link to futures-core? Or do you mean something else?
There was a problem hiding this comment.
exactly, my bad, when I navigated from IDE it showed me the crate name as futures-core sub crate which is confusing
comphead
approved these changes
Aug 24, 2024
|
Thanks @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?
Closes #.
Rationale for this change
I was looking for the page on
Partitioningbut the firstthing that comes up is the partitioning description for Logical plans
Thus I would like to link the description in the result that also appears first
What changes are included in this PR?
Add a link from logical
Partitioningto the more detailed documentationHere is what the doc looks like now:
Are these changes tested?
By doc CI and I also looked at it manually
Are there any user-facing changes?