Skip to content

Conversation

@gowtham1412-p
Copy link

@gowtham1412-p gowtham1412-p commented Oct 30, 2025

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?

  • Added TopK operator example to extending-operators.md documentation
  • Includes logical plan node, optimizer rule, physical planner, and execution plan examples
  • Added usage instructions for implementing custom TopK queries

Are 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.


### **2. Add a Comment on Issue #15774**

Go to https://github.com/apache/datafusion/issues/15774 and comment:

I've opened PR #18372 to address this issue. Please review at your earliest convenience.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 30, 2025
Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is completely replacing the existing contents of extending-operators.md page an intended change?

@gowtham1412-p gowtham1412-p force-pushed the doc-move-user-defined-plan branch from 8eedff8 to 55f9546 Compare October 30, 2025 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move code in user_defined_plan.rs to the extending-operators doc

2 participants