Repository navigation
docs: add custom TopK operator walkthrough to Extending Operators guide - #27011
Open
codewarnab wants to merge 3 commits into
Open
codewarnab wants to merge 3 commits into
codewarnab wants to merge 3 commits into
Conversation
Author
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
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?
user_defined_plan.rsto theextending-operatorsdoc #15774.Rationale for this change
The TopK example in
user_defined_plan.rsshows how to add a custom operator to DataFusion. Users who read the Extending Operators guide cannot find it there. This PR adds a short walkthrough of the example to that guide.What changes are included in this PR?
extending-operators.md. It covers:TopKPlanNodeThe µWheel section, the example code, and its invariant tests are unchanged. A follow-up PR will move the invariant tests into focused unit tests. That PR will also update the link in this section if the example moves.
What is the testing strategy for this PR?
This PR changes only documentation. The snippets and descriptions match the current code in
user_defined_plan.rs.Are there any user-facing changes?
Yes. The library user guide has a new section. There are no API changes.