docs: Move TopK example code to extending-operators documentation #18372
+168
−7
Conversation
This file contains hidden or 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
the
documentation
Jefffrey
reviewed
Oct 30, 2025
Contributor
Jefffrey
left a comment
Jefffrey
left a comment
There was a problem hiding this comment.
Is completely replacing the existing contents of extending-operators.md page an intended change?
gowtham1412-p
force-pushed
the
doc-move-user-defined-plan
branch
from
8eedff8 to
55f9546
Compare
Author
|
@Jefffrey Thank you for catching that! No, completely replacing the content was not intended. I'll update the PR to preserve the existing µWheel documentation and add the TopK example as an additional section. |
Author
|
@Jefffrey I've updated the PR to preserve the existing µWheel documentation. The TopK example is now added as a second example rather than replacing the original content. Please review when you have the convienent time |
alamb
reviewed
Nov 8, 2025
| plan: LogicalPlan, | ||
| _config: &dyn OptimizerConfig, | ||
| ) -> Result<Transformed<LogicalPlan>> { | ||
| ) -> Result<Transformed> { |
Contributor
There was a problem hiding this comment.
I am pretty sure this is an incorrect change --
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 #15774
Rationale for this change
Moving the TopK example code from the test file to user-facing documentation makes it more discoverable for users learning how to create custom operators in DataFusion.
What changes are included in this PR?
extending-operators.mddocumentationAre these changes tested?
Documentation-only change, no functional code changes.
Are there any user-facing changes?
Yes - users can now find the TopK custom operator example in the official documentation instead of having to browse test files.
I've opened PR #18372 to address this issue. Please review at your earliest convenience.